ArrayField

https://docs.sirius.menu/community/arrayfield
Admin
ArrayField is a customizable open-source interface suite offering dropdown search, element search...
Tokens:5,748
Snippets:47
Trust Score:5
Update:7 months ago
Show doc for...
Tokens:
Raw
### Initialize and Configure ArrayField Window

Source: https://docs.sirius.menu/community/arrayfield/extra/ScriptTemplate

This snippet initializes the ArrayField library and creates a main window with various configuration options. It includes settings for window appearance, saving configurations, Discord integration, and a key system. The `loadstring` function fetches the library from a remote URL.

```lua
local ArrayField = loadstring(game:HttpGet('https://raw.githubusercontent.com/UI-Interface/ArrayField/main/Source'))()
local Window = ArrayField:CreateWindow({
		Name = "ArrayField Example Window",
		LoadingTitle = "ArrayField Interface Suite",
		LoadingSubtitle = "by Arrays",
		ConfigurationSaving = {
			Enabled = true,
			FolderName = nil, -- Create a custom folder for your hub/game
			FileName = "ArrayField"
		},
		Discord = {
			Enabled = false,
			Invite = "sirius", -- The Discord invite code, do not include discord.gg/
			RememberJoins = true -- Set this to false to make them join the discord every time they load it up
		},
		KeySystem = true, -- Set this to true to use our key system
		KeySettings = {
			Title = "ArrayField",
			Subtitle = "Key System",
			Note = "Join the discord (discord.gg/sirius)",
			FileName = "ArrayFieldsKeys",
			SaveKey = false,
			GrabKeyFromSite = false, -- If this is true, set Key below to the RAW site you would like ArrayField to get the key from
			Key = {"Hello",'Bye'},
			Actions = {
				[1] = {
					Text = 'Click here to copy the key link',
					OnPress = function()

					end,
				}
			}
		}
	})
```

--------------------------------

### Create UI Section and Lockdown Mechanism in Sirius Menu

Source: https://docs.sirius.menu/community/arrayfield/extra/ScriptTemplate

This snippet demonstrates how to initialize a UI section and manage the state of multiple UI elements simultaneously. It uses a table to store references to elements, allowing a toggle to lock or unlock all contained components at once.

```Lua
local LockTesting = Tab:CreateSection('Lockdown Section', false)
local ToLock = {}

Tab:CreateToggle({
	Name = "Lockdown",
	SectionParent = LockTesting,
	CurrentValue = false,
	Callback = function(Value)
		if Value then
			for _,v in ToLock do v:Lock('Locked') end
		else
			for _,v in ToLock do v:Unlock('Locked') end
		end
	end,
})

Tab:CreateSpacing(LockTesting)

ToLock.Button = Tab:CreateButton({
	SectionParent = LockTesting,
	Name = "Button Example",
	Interact = 'Interact',
	Callback = function() print('Pressed') end,
})

ToLock.Toggle = Tab:CreateToggle({
	SectionParent = LockTesting,
	Name = "Toggle Example",
	CurrentValue = false,
	Flag = "Toggle2",
	Callback = function(Value) print(Value) end,
})

ToLock.ColorPicker = Tab:CreateColorPicker({
	Name = "Color Picker",
	SectionParent = LockTesting,
	Color = Color3.fromRGB(2, 255, 255),
	Flag = "ColorPicker2",
	Callback = function(Value) print(Value) end
})

ToLock.Slider = Tab:CreateSlider({
	SectionParent = LockTesting,
	Name = "Slider Example",
	Range = {0, 100},
	Increment = 10,
	Suffix = "Bananas",
	CurrentValue = 10,
	Flag = "Slider2",
	Callback = function(Value) print(Value) end,
})

ToLock.Keybind = Tab:CreateKeybind({
	Name = "Keybind Example",
	CurrentKeybind = "Q",
	HoldToInteract = false,
	SectionParent = LockTesting,
	Flag = "Keybind2",
	Callback = function(Keybind) end,
})
```

--------------------------------

### Create and Configure UI Elements in ArrayField Tab

Source: https://docs.sirius.menu/community/arrayfield/extra/ScriptTemplate

This snippet demonstrates the creation of various interactive UI elements within a tab of the ArrayField window. It includes buttons, toggles, color pickers, sliders, keybinds, inputs, dropdowns, labels, and paragraphs. Each element has specific properties for its appearance, behavior, and data handling, with callback functions to execute actions.

```lua
	local Tab = Window:CreateTab("Tab Example", 4483362458) -- Title, Image
	local Tab2 = Window:CreateTab("Tab Example 2") -- Title, Image
	local Section = Tab:CreateSection("Section Example",false) -- The 2nd argument is to tell if its only a Title and doesnt contain element
	Tab:CreateSpacing(nil,10)
	local Button = Tab:CreateButton({
		Name = "Button Example",
		Info = {
			Title = 'This is a Button',
			Description = 'This is a description for the button you know.',
		},
		Interact = 'Changable',
		Callback = function()
			print('Pressed')
		end,
	})
	Tab:CreateSpacing(nil,10)
	local Toggle = Tab:CreateToggle({
		Name = "Toggle Example",
		Info = {
			Title = 'Slider template',
			Image = '12735851647',
			Description = 'Just a slider for stuff',
		},
		CurrentValue = false,
		Flag = "Toggle1", -- A flag is the identifier for the configuration file, make sure every element has a different flag if you're using configuration saving to ensure no overlaps
		Callback = function(Value)
			print(Value)
		end,
	})
	Tab:CreateSpacing(nil,10)
	local ColorPicker = Tab:CreateColorPicker({
		Name = "Color Picker",
		Color = Color3.fromRGB(2,255,255),
		Flag = "ColorPicker1",
		Callback = function(Value)
			print(Value)
		end
	})
	Tab:CreateSpacing(nil,10)
	local Slider = Tab:CreateSlider({
		Name = "Slider Example",
		Range = {0, 100},
		Increment = 10,
		Suffix = "Bananas",
		CurrentValue = 10,
		Flag = "Slider1",
		Callback = function(Value)
			print(Value)
		end,
	})
	Tab:CreateSpacing(nil,10)
	local Keybind = Tab:CreateKeybind({
		Name = "Keybind Example",
		CurrentKeybind = "Q",
		HoldToInteract = false,
		Flag = "Keybind1",
		Callback = function(Keybind)

		end,
	})
	Tab:CreateSpacing(nil,10)
	local Section2 = Tab:CreateSection("Inputs Examples",true)
	Tab:CreateInput({
		Name = "Numbers Only",
		PlaceholderText = "Amount",
		NumbersOnly = true,
		OnEnter = true,
		RemoveTextAfterFocusLost = true,
		Callback = function(Text)
			print(Text)
		end,
	})
	Tab:CreateInput({
		Name = "11 Characters Limit",
		PlaceholderText = "Text",
		CharacterLimit = 11,
		RemoveTextAfterFocusLost = true,
		Callback = function(Text)
			print(Text)
		end,
	})
	Tab:CreateInput({
		Name = "No RemoveTextAfterFocusLost",
		PlaceholderText = "Input",
		RemoveTextAfterFocusLost = false,
		Callback = function(Text)
			print(Text)
		end,
	})
	local Section3= Tab:CreateSection("Dropdown Examples",true)
	local MultiSelectionDropdown = Tab:CreateDropdown({
		Name = "Multi Selection",
		Options = {"Option 1","Option 2",'Option 3'},
		CurrentOption = {"Option 1","Option 3"} ,
		MultiSelection = true,
		Flag = "Dropdown1",
		Callback = function(Option)
			print(Option)
		end,
	})
	local SingleSelection = Tab:CreateDropdown({
		Name = "Single Selection",
		Options = {"Option 1","Option 2"},
		CurrentOption = "Option 1",
		MultiSelection = false,
		Flag = "Dropdown2",
		Callback = function(Option)
			print(Option)
		end,
	})
	local Label = Tab:CreateLabel("Thanks for using Arrayfield, there were alot of issues but here we are!",Section)
	local Paragraph = Tab:CreateParagraph({Title = "Paragraph Example", Content = "Paragraph Example"},Section)
	local Sets = Tab:CreateSection('Set Functions',false)
	local SButton
	SButton = Tab:CreateButton({
		Name = "Button Example",
		Interact = 'Interact',
		SectionParent = Sets,
		Callback = function()
			SButton:Set(nil,'New Interaction')
		end
	})
	Tab:CreateButton({
		Name = "Dropdown Set",
		Interact = 'Interact',
		SectionParent = Sets,
		
```

--------------------------------

### Create an Adaptive Input (TextBox) with Options

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This code demonstrates creating an input text box. It includes options for the name, placeholder text, whether only numbers are allowed, character limit, triggering callback on Enter key press, removing text on focus loss, and a callback function that receives the input text. The 'Tab' object must be pre-defined.

```lua
local Input = Tab:CreateInput({
   Name = "Input Example",
   PlaceholderText = "Input Placeholder",
   NumbersOnly = true, -- If the user can only type numbers. Remove or set to false if none.
   CharacterLimit = 15, --max character limit. Remove or set to false
   OnEnter = true, -- Will callback only if the user pressed ENTER while being focused on the the box.
   RemoveTextAfterFocusLost = false, -- Speaks for itself.
   Callback = function(Text)
   -- The function that takes place when the input is changed
   -- The variable (Text) is a string for the value in the text box
   end,
})

```

--------------------------------

### Initialize ArrayField Window

Source: https://docs.sirius.menu/community/arrayfield/configuration/windows

Creates a new UI window using the ArrayField library. It supports configuration saving, Discord integration, and an optional key system for access control.

```lua
local Window = ArrayField:CreateWindow({
   Name = "ArrayField Example Window",
   LoadingTitle = "ArrayField Interface Suite",
   LoadingSubtitle = "by Arrays",
   ConfigurationSaving = {
      Enabled = true,
      FolderName = nil,
      FileName = "ArrayField"
   },
   Discord = {
      Enabled = false,
      Invite = "noinvitelink",
      RememberJoins = true
   },
   KeySystem = false,
   KeySettings = {
      Title = "Untitled",
      Subtitle = "Key System",
      Note = "No method of obtaining the key is provided",
      FileName = "Key",
      SaveKey = true,
      GrabKeyFromSite = false,
      Actions = {
			[1] = {
				Text = 'Click here to copy the key link <--',
				OnPress = function()
                    print('Pressed')
				end,
				}
			},
      Key = {"Hello"}
   }
})
```

--------------------------------

### Enable Configuration Saving

Source: https://docs.sirius.menu/community/arrayfield/configuration/booting-library

Initializes the automatic saving and loading of UI configurations. Requires enabling ConfigurationSaving in the CreateWindow function and calling the load method at the end of the script.

```Lua
ArrayField:LoadConfiguration()
```

--------------------------------

### Create a Color Picker with Callback

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This code demonstrates creating a color picker element. It requires a name, an initial color (Color3.fromRGB), a unique flag for configuration saving, and a callback function that receives the selected Color3 value. The 'Tab' object must be pre-defined.

```lua
local ColorPicker = Tab:CreateColorPicker({
    Name = "Color Picker",
    Color = Color3.fromRGB(255,255,255),
    Flag = "ColorPicker1", -- A flag is the identifier for the configuration file, make sure every element has a different flag if you're using configuration saving to ensure no overlaps
    Callback = function(Value)
        -- The function that takes place every time the color picker is moved/changed
        -- The variable (Value) is a Color3fromRGB value based on which color is selected
    end
})

```

--------------------------------

### Add General Optional Settings to Elements

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This demonstrates how to add optional general settings to various UI elements. These include an 'Info' table for image and description, and a 'SectionParent' to define its parent section. The 'Tab:Create______' placeholder should be replaced with the specific element creation function.

```lua
local ElementExample
ElementExample = Tab:Create______({

Info = {
   Image = '1234567890',
   Text = 'Description for the prompt'
},
SectionParent = Section -- Section it's parented to

})

```

--------------------------------

### Create a Dropdown Menu with Multi-Selection

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This code snippet shows how to create a dropdown menu. It requires a name, a list of options, the currently selected option(s), a boolean to enable/disable multi-selection, a unique flag for configuration saving, and a callback function that receives the selected option(s). The 'Tab' object must be pre-defined.

```lua
local Dropdown = Tab:CreateDropdown({
   Name = "Dropdown Example",
   Options = {"Option 1","Option 2"},
   CurrentOption = "Option 1" or {"Option 1","Option 3"},
   MultiSelection = true, -- If MultiSelections is allowed
   Flag = "Dropdown1", -- A flag is the identifier for the configuration file, make sure every element has a different flag if you're using configuration saving to ensure no overlaps
   Callback = function(Option)
   -- The function that takes place when the selected option is changed
   -- The variable (Option) is a string for the value that the dropdown was changed to
   end,
})

```

--------------------------------

### Create a Button with Callback

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This code snippet demonstrates how to create a button within a tab. It includes a name, interaction type, and a callback function that executes when the button is clicked. The 'Tab' object must be pre-defined.

```lua
local Button = Tab:CreateButton({
   Name = "Button Example",
   Interact = 'Click',
   Callback = function()
   -- The function that takes place when the button is pressed
   end,
})

```

--------------------------------

### Initialize ArrayField Library

Source: https://docs.sirius.menu/community/arrayfield/configuration/booting-library

Loads the ArrayField library into the Roblox environment using a remote source. This is the required entry point for utilizing the UI suite.

```Lua
local ArrayField = loadstring(game:HttpGet('https://raw.githubusercontent.com/UI-Interface/ArrayField/main/Source.lua'))()
```

--------------------------------

### Create a Toggle with Callback

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This code creates a toggle switch within a tab. It requires a name, initial value, a unique flag for saving configurations, and a callback function that receives the toggle's current boolean state. The 'Tab' object must be pre-defined.

```lua
local Toggle = Tab:CreateToggle({
   Name = "Toggle Example",
   CurrentValue = false,
   Flag = "Toggle1", -- A flag is the identifier for the configuration file, make sure every element has a different flag if you're using configuration saving to ensure no overlaps
   Callback = function(Value)
   -- The function that takes place when the toggle is pressed
   -- The variable (Value) is a boolean on whether the toggle is true or false
   end,
})

```

--------------------------------

### Manage Tabs and Sections

Source: https://docs.sirius.menu/community/arrayfield/configuration/windows

Functions to create tabs within a window and sections within those tabs. Includes methods for updating, locking, or destroying sections.

```lua
local Tab = Window:CreateTab("Tab Example", 4483362458)
local Section = Tab:CreateSection("Section Example", false)

Section:Set("Section Example")
Section:Destroy()
Section:Lock()
Section:Unlock()
```

--------------------------------

### Create a Slider with Callback

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This code snippet shows how to create a slider element. It requires a name, a range (min/max values), an increment step, an optional suffix for the value display, an initial value, a unique flag for configuration saving, and a callback function that receives the slider's current numerical value. The 'Tab' object must be pre-defined.

```lua
local Slider = Tab:CreateSlider({
   Name = "Slider Example",
   Range = {0, 100},
   Increment = 10,
   Suffix = "Bananas",
   CurrentValue = 10,
   Flag = "Slider1", -- A flag is the identifier for the configuration file, make sure every element has a different flag if you're using configuration saving to ensure no overlaps
   Callback = function(Value)
   -- The function that takes place when the slider changes
   -- The variable (Value) is a number which correlates to the value the slider is currently at
   end,
})

```

--------------------------------

### Enable Secure Mode

Source: https://docs.sirius.menu/community/arrayfield/configuration/booting-library

Configures the library to operate in Secure Mode to prevent game detection or crashes. This must be defined before the library is loaded.

```Lua
getgenv().SecureMode = true
local ArrayField = loadstring(game:HttpGet('https://raw.githubusercontent.com/UI-Interface/ArrayField/main/Source.lua'))()
```

--------------------------------

### Create a Keybind in ArrayField

Source: https://docs.sirius.menu/community/arrayfield/interaction/keybinds

Initializes a new keybind element within a tab. It accepts configuration parameters such as the default key, interaction mode, a unique flag for saving, and a callback function for execution.

```Lua
local Keybind = Tab:CreateKeybind({
   Name = "Keybind Example",
   CurrentKeybind = "Q",
   HoldToInteract = false,
   Flag = "Keybind1",
   Callback = function(Keybind)
   -- The function that takes place when the keybind is pressed
   end,
})
```

--------------------------------

### Prompt User Interface

Source: https://docs.sirius.menu/community/arrayfield/configuration/windows

Displays a modal prompt to the user within the ArrayField window. It requires a title, subtitle, content, and defined callback actions for user interaction.

```lua
Window:Prompt({
	Title = 'Interface Prompt',
	SubTitle = 'SubTitle',
	Content = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',
	Actions = {
		Accept = {
			Name = 'Accept',
			Callback = function()
				print('Pressed')
			end,
		}
	}
})
```

--------------------------------

### Manage UI Labels in ArrayField

Source: https://docs.sirius.menu/community/arrayfield/ui-components/text

Demonstrates how to instantiate a new Label component and update its text content dynamically using the Set method.

```lua
local Label = Tab:CreateLabel("Label Example")
Label:Set("Label Example")
```

--------------------------------

### Manage Element Visibility and State

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This code provides functions to manage existing UI elements. 'Destroy()' removes the element, 'Visible(<bool>)' controls its visibility, and 'Lock(Reason:<string>)' / 'Unlock()' manage its interactivity by locking it with an optional reason. The 'Element' object must be previously created.

```lua
Element:Destroy() -- Destroy

Element:Visible(<bool>)

Element:Lock(Reason:<string>) -- Lock
Element:Unlock()  -- Unlock

```

--------------------------------

### Manage UI Paragraphs in ArrayField

Source: https://docs.sirius.menu/community/arrayfield/ui-components/text

Shows the creation of a Paragraph component with a title and body content, and how to update these properties simultaneously.

```lua
local Paragraph = Tab:CreateParagraph({Title = "Paragraph Example", Content = "Paragraph Example"})
Paragraph:Set({Title = "Paragraph Example", Content = "Paragraph Example"})
```

--------------------------------

### Create ImageLabels in ArrayField

Source: https://docs.sirius.menu/community/arrayfield/ui-components/text

Provides the syntax for initializing an ImageLabel component. Note that this feature is currently under development.

```lua
Tab:CreateImage({
  <Normal ImageLabel settings>
})
```

--------------------------------

### Update and Manage Dropdown Menu

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

These functions allow for updating the selected option(s) of a dropdown, refreshing its options list, and adding or removing individual options. The 'Dropdown' object must be previously created.

```lua
Dropdown:Set("Option 2" or <table>) -- The new option value

Dropdown:Refresh({<table>},<selecteds>)

Dropdown:Add('test')
Dropdown:Remove('test')

```

--------------------------------

### Create and Display Notifications with ArrayField

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This function allows you to create and display notifications to the user. It supports custom titles, content, durations, images, and action buttons with callbacks. Ensure the 'ArrayField' module is accessible.

```lua
ArrayField:Notify({
   Title = "Notification Title",
   Content = "Notification Content",
   Duration = 6.5,
   Image = 4483362458,
   Actions = { -- Notification Buttons
      Ignore = {
         Name = "Okay!",
         Callback = function()
         print("The user tapped Okay!")
      end
   },
})

```

--------------------------------

### Update a Keybind programmatically

Source: https://docs.sirius.menu/community/arrayfield/interaction/keybinds

Updates the assigned key for an existing keybind instance. The method accepts a string representing the new key to be bound.

```Lua
Keybind:Set("RightCtrl")
```

--------------------------------

### Update Button Text

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This function updates the text displayed on an existing button. It takes the new text and the interaction type as arguments. The 'Button' object must be previously created.

```lua
Button:Set("Button Example","Interact")

```

--------------------------------

### Update Toggle State

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This function sets the new state of an existing toggle switch. It accepts a boolean value to represent the desired state (true for on, false for off). The 'Toggle' object must be previously created.

```lua
Toggle:Set(false)

```

--------------------------------

### Update Color Picker Value

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This function sets a new color for an existing color picker element. It accepts a Color3.fromRGB value representing the desired color. The 'ColorPicker' object must be previously created.

```lua
ColorPicker:Set(Color3.fromRGB(255,255,255))

```

--------------------------------

### Destroy Interface

Source: https://docs.sirius.menu/community/arrayfield/configuration/windows

Removes the entire ArrayField interface from the screen.

```lua
ArrayField:Destroy()
```

--------------------------------

### Update Slider Value

Source: https://docs.sirius.menu/community/arrayfield/interaction/interactive-elements

This function sets a new numerical value for an existing slider element. It accepts an integer representing the desired slider position. The 'Slider' object must be previously created.

```lua
Slider:Set(10) -- The new slider integer value

```
Tokens:
Raw