README.md

SUI : script UI

UI Library for browser mod menus or userscripts.
custom theming coming soon

Overview

This library provides a basic way to create GUI menus and buttons using JavaScript. It's designed to be injected and executed directly in the browser's developer console. The library allows you to define menus, add buttons to them, and customize their appearance.

Features

• Create customizable menus with buttons.
• Apply styles to menus and buttons.
• Make menus draggable.

Usage

1. Open the developer console in your browser.
2. Copy and paste the library code from main.js into the console.
3. Use the provided functions to create menus and buttons, and then call SUI.render() to display the GUI.

Single page example

// Create main menu w/ buttons
let template = new SUI.panel('Template', '20px', '20px');
template.addText('This is some sample text.');
template.addButton('Button', () => alert('Button clicked!'));
template.addSlider('Slider', 0, 100, 50, (value) => console.log('Slider value:', value));
template.addInput('Input', 'Default value', (value) => console.log('Input value:', value));
template.addText('Beta features:');
template.addCheckbox('Checkbox', true, (isChecked) => {
    console.log('Checkbox state:', isChecked);
});

template.addColorPicker('Color Picker', '#00ff00', (color) => {
    console.log('Selected color:', color);
});

// Create overlay
let overlay = new SUI.overlay('Template')

window.addEventListener('keydown', (event) => {
   if (event.code === 'ShiftRight') {
       template.toggle()
       overlay.toggle()
   }
});

// Call render to display the GUI
SUI.renderer.render();

multi-page example

// Create main menu w/ buttons
let template = new SUI.panel('Template', '20px', '20px');

function defaultPage() {
    template.clear()
    template.addText('default page');
    template.addButton('Button', () => alert('Button clicked!'));
    template.addSlider('Slider', 0, 100, 50, (value) => console.log('Slider value:', value));
    template.addInput('Input', 'Default value', (value) => console.log('Input value:', value));
    template.addButton('Go to other page', () => otherPage());
    SUI.renderer.render()
}
function otherPage() {
    template.clear()
    template.addText('other page');
    template.addButton('Back', () => defaultPage());
    SUI.renderer.render()
}


// Create overlay
let overlay = new SUI.overlay('Template')

window.addEventListener('keydown', (event) => {
  if (event.code === 'ShiftRight') {
      template.toggle()
      overlay.toggle()
  }
});

// go to default page
defaultPage()

// Call render to display the GUI
SUI.renderer.render();