first commit

admin/tool/componentlibrary/examples/actionmenu.php

@@ -0,0 +1,159 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Moodle Component Library
+ *
+ * A sample of a default action menu.
+ *
+ * @package    tool_componentlibrary
+ * @copyright  2023 Ferran Recio <ferran@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+require_once(__DIR__ . '/../../../../config.php');
+
+global $PAGE;
+
+$PAGE->set_url(new moodle_url('/admin/tool/componentlibrary/examples/actionmenu.php'));
+$PAGE->set_context(context_system::instance());
+$PAGE->set_pagelayout('embedded');
+
+$PAGE->set_heading('Moodle action menus');
+$PAGE->set_title('Moodle action menus');
+
+/** @var core_renderer $output*/
+$output = $PAGE->get_renderer('core');
+
+// Some menu items require as renderable element. This is just an
+// example of a choice list but it can be any other renderable.
+$choice = new core\output\choicelist('Choice example');
+$choice->add_option("statusa", "Status A", [
+    'url' => $PAGE->url,
+    'description' => 'Status A description',
+    'icon' => new pix_icon('t/user', '', ''),
+]);
+$choice->add_option("statusb", "Status B", [
+    'url' => $PAGE->url,
+    'description' => 'Status B description',
+    'icon' => new pix_icon('t/groupv', '', ''),
+]);
+$choice->set_selected_value('statusb');
+
+// Those are some examples of action items.
+
+// Action menu links is the most used action item.
+$basicactionlink = new action_menu_link(
+    new moodle_url($PAGE->url),
+    new pix_icon('t/emptystar', ''),
+    'Action link example',
+    false
+);
+
+// Subpanels display lateral panels on hovered or clicked.
+$subpanel = new core\output\local\action_menu\subpanel(
+    'Subpanel example',
+    $choice
+);
+
+echo $output->header();
+
+echo '<p><strong>Important note:</strong> actions menus are not prepared
+    to be displayed inside iframes. You may need to scroll to see the
+    action menu options.</p>';
+
+echo $output->heading("Action menu default example", 4);
+
+$menu = new action_menu();
+
+$menu->add($basicactionlink);
+$menu->add($basicactionlink);
+$menu->add($subpanel);
+$menu->add($basicactionlink);
+
+echo '<div class="border m-3 p-3 d-flex flex-row">';
+echo '<div class="flex-fill">Example of default an action menu</div><div>';
+echo $OUTPUT->render($menu);
+echo '</div></div>';
+
+echo $output->heading("Kebab menu example", 4);
+
+$menu = new action_menu();
+$menu->set_kebab_trigger(get_string('edit'), $output);
+$menu->set_additional_classes('fields-actions');
+
+$menu->add($basicactionlink);
+$menu->add($basicactionlink);
+$menu->add(new core\output\local\action_menu\subpanel(
+    'Subpanel example',
+    $choice
+));
+$menu->add($basicactionlink);
+
+echo '<div class="border m-3 p-3 d-flex flex-row">';
+echo '<div class="flex-fill">Example of kebab menu</div><div>';
+echo $OUTPUT->render($menu);
+echo '</div></div>';
+
+echo $output->heading("Custom trigger menu example", 4);
+
+$menu = new action_menu();
+$menu->set_menu_trigger(get_string('edit'));
+
+$menu->add($basicactionlink);
+$menu->add($basicactionlink);
+$menu->add(new core\output\local\action_menu\subpanel(
+    'Subpanel example',
+    $choice
+));
+$menu->add($basicactionlink);
+
+echo '<div class="border m-3 p-3 d-flex flex-row">';
+echo '<div class="flex-fill">Example of kebab menu</div><div>';
+echo $OUTPUT->render($menu);
+echo '</div></div>';
+
+echo $output->heading("Primary actions menu example", 4);
+
+$menu = new action_menu();
+$menu->set_menu_trigger(get_string('edit'));
+
+$menu->add($basicactionlink);
+$menu->add($basicactionlink);
+$menu->add(new core\output\local\action_menu\subpanel(
+    'Subpanel example',
+    $choice
+));
+$menu->add($basicactionlink);
+$menu->add(new action_menu_link_primary(
+    $PAGE->url,
+    new pix_icon('t/emptystar', ''),
+    'Action link example',
+));
+$menu->add(new action_menu_link_primary(
+    $PAGE->url,
+    new pix_icon('t/user', ''),
+    'Action link example',
+));
+
+echo '<div class="border m-3 p-3 d-flex flex-row">';
+echo '<div class="flex-fill">Example of a menu with primary actions</div><div>';
+echo $OUTPUT->render($menu);
+echo '</div></div>';
+
+echo $output->footer();

admin/tool/componentlibrary/examples/dropdowns.php

@@ -0,0 +1,124 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Moodle Component Library
+ *
+ * A sample page with dropdowns.
+ *
+ * @package    tool_componentlibrary
+ * @copyright  2023 Ferran Recio <ferran@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+require_once(__DIR__ . '/../../../../config.php');
+
+require_login();
+require_capability('moodle/site:configview', context_system::instance());
+
+global $PAGE, $OUTPUT;
+$PAGE->set_url(new moodle_url('/admin/tool/componentlibrary/examples/dropdowns.php'));
+$PAGE->set_context(context_system::instance());
+$PAGE->set_pagelayout('embedded');
+
+$PAGE->set_heading('Moodle dropdowns');
+$PAGE->set_title('Moodle dropdowns');
+
+/** @var core_renderer $output*/
+$output = $PAGE->get_renderer('core');
+
+echo $output->header();
+
+echo $output->paragraph(
+    '<strong>Important note:</strong> dropdowns are not prepared
+    to be displayed inside iframes. You may need to scroll to see the
+    the dropdown content.'
+);
+
+echo $output->heading("Dropdown dialog example", 3);
+echo '<div class="p-3">';
+
+$dialog = new core\output\local\dropdown\dialog(
+    'Open dialog',
+    '<p>Some rich content <b>element</b>.</p>
+    <ul>
+        <li>Item 1 <a href="#">Link 1</a></li>
+        <li>Item 2 <a href="#">Link 2</a></li>
+    </ul>'
+);
+echo $OUTPUT->render($dialog);
+echo "</div>";
+
+
+echo $output->heading("Dropdown status example", 3);
+echo '<div class="p-3">';
+
+$choice = new core\output\choicelist('Choice description text');
+
+// Option one is a link.
+$choice->add_option('option1', 'Option 1', [
+    'icon' => new pix_icon('t/show', 'Eye icon 1'),
+    'url' => new moodle_url('/admin/tool/componentlibrary/examples/dropdowns.php'),
+]);
+// Option two has an icon and description.
+$choice->add_option('option2', 'Option 2', [
+    'description' => 'Option 2 description',
+    'icon' => new pix_icon('t/hide', 'Eye icon 2'),
+]);
+// Option three is disabled.
+$choice->add_option('option3', 'Option 3', [
+    'description' => 'Option 3 description',
+    'icon' => new pix_icon('t/stealth', 'Eye icon 3'),
+    'disabled' => true,
+]);
+
+$choice->set_selected_value('option2');
+
+$dialog = new core\output\local\dropdown\status('Open dialog button', $choice);
+echo $OUTPUT->render($dialog);
+echo "</div>";
+
+echo $output->heading("Dropdown status in update mode example", 3);
+echo '<div class="p-3">';
+
+$choice = new core\output\choicelist('Choice description text');
+
+$choice->add_option('option1', 'Option 1', [
+    'description' => 'Option 1 description',
+    'icon' => new pix_icon('t/show', 'Eye icon 1'),
+]);
+$choice->add_option('option2', 'Option 2', [
+    'description' => 'Option 2 description',
+    'icon' => new pix_icon('t/hide', 'Eye icon 2'),
+]);
+
+$choice->set_selected_value('option2');
+
+$dialog = new core\output\local\dropdown\status(
+    'Open dialog button',
+    $choice,
+    [
+        'buttonsync' => true,
+        'updatestatus' => true,
+        'dialogwidth' => core\output\local\dropdown\status::WIDTH['big']
+    ]
+);
+echo $OUTPUT->render($dialog);
+echo "</div>";
+
+echo $output->footer();

admin/tool/componentlibrary/examples/dynamictabs.php

@@ -0,0 +1,54 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Moodle Component Library
+ *
+ * A sample page with dynamic tabs.
+ *
+ * @package    tool_componentlibrary
+ * @copyright  2021 David Matamoros <davidmc@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+require_once(__DIR__ . '/../../../../config.php');
+
+use core\output\dynamic_tabs;
+
+require_login();
+require_capability('moodle/site:configview', context_system::instance());
+
+global $PAGE, $OUTPUT;
+$PAGE->set_url(new moodle_url('/admin/tool/componentlibrary/examples/dynamictabs.php'));
+$PAGE->set_context(context_system::instance());
+$PAGE->set_pagelayout('embedded');
+
+$PAGE->set_heading('Moodle dynamic tabs');
+$PAGE->set_title('Moodle dynamic tabs');
+
+echo $OUTPUT->header();
+
+// Add dynamic tabs to our page.
+$tabs = [
+    new \tool_componentlibrary\local\examples\dynamictabs\tab1(['demotab' => 'Tab1']),
+    new \tool_componentlibrary\local\examples\dynamictabs\tab2(['demotab' => 'Tab2']),
+];
+echo $OUTPUT->render_from_template('core/dynamic_tabs',
+    (new dynamic_tabs($tabs))->export_for_template($OUTPUT));
+
+echo $OUTPUT->footer();

admin/tool/componentlibrary/examples/formfields.php

@@ -0,0 +1,59 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Moodle Component Library
+ *
+ * A sample form with most of the available form elements.
+ *
+ * @package    tool_componentlibrary
+ * @copyright  2021 Bas Brands <bas@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once(__DIR__ . '/../../../../config.php');
+require_once($CFG->dirroot.'/lib/formslib.php');
+
+require_login();
+require_capability('moodle/site:configview', context_system::instance());
+
+$repeatcount = optional_param('test_repeat', 1, PARAM_INT);
+
+$PAGE->set_pagelayout('embedded');
+
+$url = new moodle_url('/admin/tool/componentlibrary/examples/formfields.php');
+
+$toggles  = (object)[];
+$toggles->defaulturl = $url;
+$toggles->helpurl = new moodle_url('/admin/tool/componentlibrary/examples/formfields.php', ['help' => 1]);
+$toggles->requiredurl = new moodle_url('/admin/tool/componentlibrary/examples/formfields.php', ['required' => 1]);
+$toggles->bothurl = new moodle_url('/admin/tool/componentlibrary/examples/formfields.php', ['help' => 1, 'required' => 1]);
+$toggles->mixedurl = new moodle_url('/admin/tool/componentlibrary/examples/formfields.php',
+    ['help' => 1, 'required' => 1, 'mixed' => 1]);
+
+$PAGE->set_url($url);
+$PAGE->set_context(context_system::instance());
+
+$PAGE->set_heading('Moodle form fields');
+$PAGE->set_title('Moodle form fields');
+
+$form = new \tool_componentlibrary\local\examples\formelements\example($url, ['repeatcount' => $repeatcount]);
+
+echo $OUTPUT->header();
+
+echo $OUTPUT->render_from_template('tool_componentlibrary/examples/formelements/toggles', $toggles);
+$form->display();
+echo $OUTPUT->footer();

admin/tool/componentlibrary/examples/singlebuttons.php

@@ -0,0 +1,59 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Moodle Component Library
+ *
+ * A sample of different singlebuttons
+ *
+ * @package    tool_componentlibrary
+ * @copyright  2022 Laurent David <laurent.david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once(__DIR__ . '/../../../../config.php');
+require_once($CFG->dirroot . '/lib/formslib.php');
+
+require_login();
+require_capability('moodle/site:configview', context_system::instance());
+
+$repeatcount = optional_param('test_repeat', 1, PARAM_INT);
+
+$PAGE->set_pagelayout('embedded');
+
+$url = new moodle_url('/admin/tool/componentlibrary/examples/singlebuttons.php');
+$PAGE->set_url($url);
+$PAGE->set_context(context_system::instance());
+
+$PAGE->set_heading('Moodle single buttons');
+$PAGE->set_title('Moodle single buttons');
+
+$buttondefinitions = [
+    ['label' => 'Standard'],
+    ['label' => 'Primary', 'type' => single_button::BUTTON_PRIMARY],
+    ['label' => 'Danger', 'type' => single_button::BUTTON_DANGER],
+    ['label' => 'Warning', 'type' => single_button::BUTTON_WARNING],
+    ['label' => 'Success', 'type' => single_button::BUTTON_SUCCESS],
+    ['label' => 'Info', 'type' => single_button::BUTTON_INFO],
+
+];
+echo $OUTPUT->header();
+foreach ($buttondefinitions as $def) {
+    $button = new single_button($url, $def['label'], 'post', $def['type'] ??
+        single_button::BUTTON_SECONDARY, $def['attributes'] ?? []);
+    echo $OUTPUT->render($button);
+}
+echo $OUTPUT->footer();