Overview

The Simple Button library provides an easy way to create interactive buttons in ComputerCraft programs. It handles button drawing, click detection, and state management, making it simple to add interactive elements to your terminal or monitor interfaces.

Installation

Install the library using gfetch:

gfetch manaphoenix/CC-Code/main/lib/simpleButton.lua
Alternative: Use wget
wget https://raw.githubusercontent.com/manaphoenix/CC-Code/main/lib/simpleButton.lua

Basic Usage

Create and manage interactive buttons with minimal code. Supports both regular buttons and toggle buttons with different visual states.

lua Basic Usage 
local SimpleButton = require("simpleButton")

-- Create a regular button
local button = SimpleButton.new({
    x = 5, y = 5,
    width = 10, height = 3,
    text = "Click Me!",
    textColor = colors.white,
    backgroundColor = colors.blue,
    onClick = function()
        print("Button clicked!")
    end
})

-- In your event loop:
while true do
    local event, p1, p2, p3 = os.pullEvent()
    SimpleButton.handleEvent(event, p1, p2, p3)
    SimpleButton.drawAll()
end

Methods

new ( options: table ) : SimpleButton

Creates a new button instance with the specified options.

Example Code
lua 
local SimpleButton = require("simpleButton")

-- Create a toggle button
local toggle = SimpleButton.new({
    x = 5, y = 5,
    width = 15, height = 3,
    text = "Toggle Me",
    isToggle = true,
    toggled = false,
    textColor = colors.white,
    backgroundColorOn = colors.green,
    backgroundColorOff = colors.red,
    onToggle = function(self)
        print("Toggled:", self.toggled)
    end
})

drawAll ( ) : void

Draws all created buttons on the screen.

Example Code
lua 
-- In your draw/refresh function:
SimpleButton.drawAll()

handleEvent ( event: string, _: any, x: number, y: number ) : void

Handles mouse/touch events and triggers button actions when clicked.

Example Code
lua 
-- In your event loop:
local event, p1, p2, p3 = os.pullEvent()
SimpleButton.handleEvent(event, p1, p2, p3)

Button Methods ( ) : void

Methods available on button instances.

Example Code
lua 
-- draw() - Redraws the button
button:draw()

-- within(x, y) - Checks if coordinates are within the button
if button:within(5, 5) then
    print("Coordinates are within button bounds")
end

-- fire() - Triggers the button's action
button:fire()

Examples

lua Basic Button 
local SimpleButton = require("simpleButton")

-- Create a simple button
local button = SimpleButton.new({
    x = 2, y = 2,
    width = 20, height = 3,
    text = "Click Me!",
    textColor = colors.white,
    backgroundColor = colors.blue,
    onClick = function()
        print("Button was clicked!")
    end
})

-- Simple event loop
while true do
    button:draw()
    local event, _, x, y = os.pullEvent()
    if event == "mouse_click" or event == "monitor_touch" then
        if button:within(x, y) then
            button:fire()
        end
    end
end
lua Toggle Button 
local SimpleButton = require("simpleButton")

-- Create a toggle button
local toggle = SimpleButton.new({
    x = 2, y = 2,
    width = 20, height = 3,
    text = "Toggle Me",
    isToggle = true,
    toggled = false,
    textColor = colors.white,
    backgroundColorOn = colors.green,
    backgroundColorOff = colors.red,
    onToggle = function(self)
        print("Toggle state:", self.toggled)
    end
})

-- Event loop with drawAll
while true do
    term.clear()
    SimpleButton.drawAll()
    local event = {os.pullEvent()}
    SimpleButton.handleEvent(table.unpack(event))
end

Advanced Usage

lua Dynamic Button Creation 
local SimpleButton = require("simpleButton")

local buttons = {}
local options = {
    {name = "Option 1", x = 2, y = 2},
    {name = "Option 2", x = 2, y = 6},
    {name = "Option 3", x = 2, y = 10}
}

-- Create buttons from options
for i, opt in ipairs(options) do
    buttons[i] = SimpleButton.new({
        x = opt.x,
        y = opt.y,
        width = 15,
        height = 3,
        text = opt.name,
        textColor = colors.white,
        backgroundColor = colors.blue,
        onClick = function()
            print("Selected:", opt.name)
        end
    })
end

-- Event loop
while true do
    SimpleButton.drawAll()
    local event = {os.pullEvent()}
    SimpleButton.handleEvent(table.unpack(event))
end
lua Button with Custom Drawing 
local SimpleButton = require("simpleButton")

-- Create a custom button
local customBtn = SimpleButton.new({
    x = 2, y = 2,
    width = 20, height = 3,
    text = "Custom",
    textColor = colors.white,
    backgroundColor = colors.purple
})

-- Override draw method
local oldDraw = customBtn.draw
function customBtn:draw()
    -- Call original draw
    oldDraw(self)
    
    -- Add custom decoration
    term.setCursorPos(self.x + 1, self.y + 1)
    term.blit("★", colors.toBlit(colors.yellow), colors.toBlit(colors.purple))
end

-- Event loop
while true do
    term.clear()
    SimpleButton.drawAll()
    local event = {os.pullEvent()}
    SimpleButton.handleEvent(table.unpack(event))
end