Nacre-UI Help

Form

Simple Form

Les simples form sont les formulaires les plus simples à utiliser. Ils sont utilisés pour toutes les actions qui peuvent être faites seulement en appuyant sur un bouton.

  1. Crée la base d'un simple form

    use nacre\form\class\SimpleForm; use nacre\form\elements\buttons\SimpleButton; // Votre code $form = new SimpleForm( 'Titre du formulaire', 'Contenu du formulaire', [ new SimpleButton('nom du bouton', 'texte du bouton', /* Fichier Icon (optionnel) */, 'permission (optionnel)'), ], function (Player $player, string $data) { #Optionnel // $data renvoie le nom du bouton // Action à effectuer lors de appui sur un bouton }, function (Player $player) { #Optionnel // Action à effectuer lors de la fermeture du formulaire } ); $player->sendForm($form);
  2. Comment détecter quel bouton est cliqué ?

    if ($data['nom du bouton']) { // Action à effectuer lors de appui sur le bouton }
  3. Comment ajouter une permission à votre simple form ?

    $form->setPermission('nom de la permission');

Custom Form

Les custom form, sont des formulaires qui permettent de créer des interfaces plus complexes avec par exemple la présence d'éléments comme des input, des slider, des dropdown, etc...

  1. Crée la base d'un simple form

    use nacre\form\class\CustomForm; // Votre code $form = new CustomForm( 'Titre du formulaire', 'Contenu du formulaire', [ #Elements ], function (Player $player, $data) { #Optionnel // Action à effectuer lors de l appui sur le bouton }, function (Player $player) { #Optionnel // Action à effectuer lors de la fermeture du formulaire } ); $player->sendForm($form);
  2. Comment détecter quel élément est cliqué ?

    if ($data['nom de l élément']) { // Action à effectuer lors de l appui sur l élément }

    Voici la liste des éléments disponibles.

    use nacre\form\elements\customs\Dropdown; ... new Dropdown('element-name', 'text', ['option 1', 'option 2'], 0 /* default option (optionnel) */);
    use nacre\form\elements\customs\Input; ... new Input('element-name', 'text' (optionnel), 'placeholder' (optionnel), 'default text' (optionnel));
    use nacre\form\elements\customs\Label; ... new Label('text');
    use nacre\form\elements\customs\Slider; ... new Slider('element-name', 'text', 0, 100, 1, 0);
    use nacre\form\elements\customs\StepSlider; ... new StepSlider('element-name', 'text' (optionnel), ['step 1', 'step 2'], 0 /* default step (optionnel) */);
    use nacre\form\elements\customs\Toggle; ... new Toggle('element-name', 'text' (optionnel), 'default' (optionnel));
  3. Comment ajouter une permission à votre custom form ?

    $form->setPermission('nom de la permission');

Les modal form sont des interfaces de dialogue. Ils sont utilisés pour afficher des messages, des avertissements, des quêtes, etc...

  1. Crée la base d'un modal form

    use nacre\form\class\ModalForm; // Votre code $form = new ModalForm( 'Titre du formulaire', 'Contenu du formulaire', new ModalButton('nom du bouton', 'Text', permission), new ModalButton('nom du bouton', 'Text2', permission), function (Player $player, $data) { #Optionnel //$data renvoi également le nom du bouton // Action à effectuer lors de appui sur le bouton }, function (Player $player) { #Optionnel // Action à effectuer lors de la fermeture du formulaire } ); $player->sendForm($form);
  2. Comment détecter quel bouton est cliqué ?

    $data['nom du bouton 1'] = Bouton 1 $data['nom du bouton 2'] = Bouton 2
  3. Comment ajouter une permission à votre modal form ?

    $form->setPermission('nom de la permission');
Last modified: 29 juin 2024