. /** * Moodle Component Library * * A sample of a default action menu. * * @package tool_componentlibrary * @copyright 2023 Ferran Recio * @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 '

Important note: actions menus are not prepared to be displayed inside iframes. You may need to scroll to see the action menu options.

'; echo $output->heading("Action menu default example", 3); $menu = new action_menu(); $menu->add($basicactionlink); $menu->add($basicactionlink); $menu->add($subpanel); $menu->add($basicactionlink); echo '

'; echo '

An action menu rendered without customisation

'; echo $OUTPUT->render($menu); echo '

'; echo $output->heading("Kebab menu example", 3); $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 '

'; echo '

An action menu with a kebab menu trigger button

'; echo $OUTPUT->render($menu); echo '

'; echo $output->heading("Custom trigger menu examples", 3); $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 '

'; echo '

An action menu with a menu trigger button with a custom text label

'; echo $OUTPUT->render($menu); echo '

'; $links = [ $basicactionlink, $basicactionlink, ]; $moreicon = $OUTPUT->pix_icon('i/moremenu', ''); $editicon = $OUTPUT->pix_icon('t/edit', ''); $menu = new action_menu($links); $menu->set_menu_trigger($moreicon); $menu->set_action_label(get_string('moremenu')); $menu->triggerattributes = [ 'title' => get_string('moremenu'), ]; echo '

'; echo '

An action menu with only an icon for its custom menu trigger button

'; echo html_writer::div($OUTPUT->render($menu)); echo '

'; echo '

An action menu with only an icon for its custom menu trigger button with the caret removed

'; $menu->triggerextraclasses = 'no-caret'; echo html_writer::div($OUTPUT->render($menu)); echo '

'; $menu = new action_menu($links); $menu->set_menu_trigger($editicon . ' ' . get_string('edit')); echo '

'; echo '

An action menu with an icon and visible text for its custom menu trigger button

'; echo html_writer::div($OUTPUT->render($menu)); echo '

'; $menu = new action_menu($links); $menu->set_menu_trigger($editicon . ' ' . html_writer::span(get_string('edit'), 'visually-hidden')); echo '

'; echo '

An action menu with an icon and visually hidden text for its custom menu trigger button

'; echo html_writer::div($OUTPUT->render($menu)); echo '

'; echo $output->heading("Primary actions menu example", 3); $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 '

'; echo '

Example of a menu with primary actions

'; echo $OUTPUT->render($menu); echo '

'; echo $output->footer();