Describes the Popover component. More...
Inheritance diagram for ILIAS\UI\Component\Popover\Popover:
Collaboration diagram for ILIAS\UI\Component\Popover\Popover:
Public Member Functions | |
| withTitle (string $title) | |
| Get the same popover displaying a title above the content. More... | |
| getTitle () | |
| Get the title of the popover. More... | |
| withVerticalPosition () | |
| Get the same popover being rendered below or above the trigger, based on the available space. More... | |
| withHorizontalPosition () | |
| Get the same popover being rendered to the left or right of the trigger, based on the available space. More... | |
| getPosition () | |
| Get the position of the popover. More... | |
| withAsyncContentUrl (string $url) | |
| Get a popover like this who's content is rendered via ajax by the given $url before the popover is shown. More... | |
| getAsyncContentUrl () | |
| Get the url returning the rendered content, if the popovers content is rendered via ajax. More... | |
| getShowSignal () | |
| Get the signal to show this popover in the frontend. More... | |
| getReplaceContentSignal () | |
| Get the signal to replace the content of this popover. More... | |
| withFixedPosition () | |
| Get a popover which can be used in fixed places such as the main menu. More... | |
| isFixedPosition () | |
| Public Member Functions inherited from ILIAS\UI\Component\Component | |
| getCanonicalName () | |
| Get the canonical name of the component. More... | |
| reduceWith (\Closure $fn) | |
| The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More... | |
| Public Member Functions inherited from ILIAS\UI\Component\Triggerable | |
| withResetSignals () | |
| Get a component like this but reset (regenerate) its signals. More... | |
| Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable | |
| withOnLoadCode (Closure $binder) | |
| withAdditionalOnLoadCode (Closure $binder) | |
| Add some onload-code to the component instead of replacing the existing one. More... | |
| getOnLoadCode () | |
| Get the currently bound on load code. More... | |
Data Fields | |
| const | POS_AUTO = 'auto' |
| const | POS_VERTICAL = 'vertical' |
| const | POS_HORIZONTAL = 'horizontal' |
Detailed Description
Describes the Popover component.
Definition at line 31 of file Popover.php.
Member Function Documentation
◆ getAsyncContentUrl()
| ILIAS\UI\Component\Popover\Popover::getAsyncContentUrl | ( | ) |
Get the url returning the rendered content, if the popovers content is rendered via ajax.
◆ getPosition()
| ILIAS\UI\Component\Popover\Popover::getPosition | ( | ) |
Get the position of the popover.
◆ getReplaceContentSignal()
| ILIAS\UI\Component\Popover\Popover::getReplaceContentSignal | ( | ) |
Get the signal to replace the content of this popover.
◆ getShowSignal()
| ILIAS\UI\Component\Popover\Popover::getShowSignal | ( | ) |
Get the signal to show this popover in the frontend.
◆ getTitle()
| ILIAS\UI\Component\Popover\Popover::getTitle | ( | ) |
Get the title of the popover.
◆ isFixedPosition()
| ILIAS\UI\Component\Popover\Popover::isFixedPosition | ( | ) |
- Returns
- bool whether it's fixed or not
◆ withAsyncContentUrl()
| ILIAS\UI\Component\Popover\Popover::withAsyncContentUrl | ( | string | $url | ) |
Get a popover like this who's content is rendered via ajax by the given $url before the popover is shown.
Means: After the show signal has been triggered but before the popover is displayed to the user, an ajax request is sent to this url. The request MUST return the rendered content for the popover.
◆ withFixedPosition()
| ILIAS\UI\Component\Popover\Popover::withFixedPosition | ( | ) |
Get a popover which can be used in fixed places such as the main menu.
This popover will stay fixed when scrolling and therefore remain on the screen.
◆ withHorizontalPosition()
| ILIAS\UI\Component\Popover\Popover::withHorizontalPosition | ( | ) |
Get the same popover being rendered to the left or right of the trigger, based on the available space.
◆ withTitle()
| ILIAS\UI\Component\Popover\Popover::withTitle | ( | string | $title | ) |
Get the same popover displaying a title above the content.
◆ withVerticalPosition()
| ILIAS\UI\Component\Popover\Popover::withVerticalPosition | ( | ) |
Get the same popover being rendered below or above the trigger, based on the available space.
Field Documentation
◆ POS_AUTO
| const ILIAS\UI\Component\Popover\Popover::POS_AUTO = 'auto' |
Definition at line 33 of file Popover.php.
◆ POS_HORIZONTAL
| const ILIAS\UI\Component\Popover\Popover::POS_HORIZONTAL = 'horizontal' |
Definition at line 35 of file Popover.php.
◆ POS_VERTICAL
| const ILIAS\UI\Component\Popover\Popover::POS_VERTICAL = 'vertical' |
Definition at line 34 of file Popover.php.
The documentation for this interface was generated from the following file:
- components/ILIAS/UI/src/Component/Popover/Popover.php
