Skip to main content

Custom Form

To make a Custom Form we need to add the "use" statement.

use jojoe77777\FormAPI\CustomForm;

Now lets make a function to add our form in it.

public function testForm($player) 
{
//This is where we will add our form.
}

In the function we will add our form:

public function testForm($player)
{
$form = new CustomForm(function(Player $player, $data){
var_dump($data); // Sends all data to console
});

$player->sendForm($form); //This sends it to the player
}

Title

Let us set the title of the form.

public function testForm($player)
{
$form = new CustomForm(function(Player $player, $data){
var_dump($data);
});

//This sets the title of the form
$form->setTitle("Choose Your Title");

$player->sendForm($form);
}

customform-title

Lets add a Dropdown to the form

public function testForm($player)
{
$form = new CustomForm(function(Player $player, $data){
var_dump($data);
});

$form->setTitle("Choose Your Title");

//This adds a Dropdowm, Options 1 & 2
$form->addDropdown("DropDown", ["Dropdown 1", "Dropdown 2"]);

$player->sendForm($form);
}

customform-dropdown customform-dropdown

Input

Lets add a Input to the form

public function testForm($player)
{
$form = new CustomForm(function(Player $player, $data){
var_dump($data);
});

$form->setTitle("Choose Your Title");
$form->addDropdown("DropDown", ["Dropdown 1", "Dropdown 2"]);

//This adds a Input
$form->addInput("Enter Text", "Enter some text here");

$player->sendForm($form);
}

customform-input

Slider

Lets add a Slider to the form

public function testForm($player)
{
$form = new CustomForm(function(Player $player, $data){
var_dump($data);
});

$form->setTitle("Choose Your Title");
$form->addDropdown("DropDown", ["Dropdown 1", "Dropdown 2"]);
$form->addInput("Enter Text", "Enter some text here");

// This adds a Slider, Min 1, Max 10
$form->addSlider("Choose a value", 1, 10);

$player->sendForm($form);
}

customform-slider

Step Slider

Lets add a Step Slider to the form

public function testForm($player)
{
$form = new CustomForm(function(Player $player, $data){
var_dump($data);
});

$form->setTitle("Choose Your Title");
$form->addDropdown("DropDown", ["Dropdown 1", "Dropdown 2"]);
$form->addInput("Enter Text", "Enter some text here");
$form->addSlider("Choose a value", 1, 10);

//This adds a Step Slider, Hi!, Hello!, Sup!
$form->addStepSlider("Choose a word from", ["Hi!", "Hello!", "Sup!"]);

$player->sendForm($form);
}

customform-stepslider

Label

Lets add a Label to the form

public function testForm($player)
{
$form = new CustomForm(function(Player $player, $data){
var_dump($data);
});

$form->setTitle("Choose Your Title");
$form->addDropdown("DropDown", ["Dropdown 1", "Dropdown 2"]);
$form->addInput("Enter Text", "Enter some text here");
$form->addSlider("Choose a value", 1, 10);
$form->addStepSlider("Choose a word from", ["Hi!", "Hello!", "Sup!"]);

//This adds a Label to the form
$form->addLabel("Text from your label");

$player->sendForm($form);
}

customform-label

Toggle

Lets add a Toggle to the form

public function testForm($player)
{
$form = new CustomForm(function(Player $player, $data){
var_dump($data);
});

$form->setTitle("Choose Your Title");
$form->addDropdown("DropDown", ["Dropdown 1", "Dropdown 2"]);
$form->addInput("Enter Text", "Enter some text here");
$form->addSlider("Choose a value", 1, 10);
$form->addStepSlider("Choose a word from", ["Hi!", "Hello!", "Sup!"]);
$form->addLabel("Text from your label");

//This adds a Toggle to the form
$form->addToggle("Enable or disable");

$player->sendForm($form);
}

customform-toggle