Inheritance diagram for ILIAS\UI\Component\Deck\Deck:
Collaboration diagram for ILIAS\UI\Component\Deck\Deck:
Public Member Functions | |
| withCards (array $cards) | |
| Set the cards to be displayed in the deck. More... | |
| getCards () | |
| withExtraSmallCardsSize () | |
| Set the cards size to extra small: 3 (xs-4) 6 (sm-2) 6 (md-2) 12 (lg-1) More... | |
| withSmallCardsSize () | |
| Set the cards size to small: 2 (xs-6) 4 (sm-3) 4 (md-3) 6 (lg-2) More... | |
| withNormalCardsSize () | |
| Set the cards size to normal: 1 (xs-12) 2 (sm-6) 3 (md-4) 4 (lg-3) More... | |
| withLargeCardsSize () | |
| Set the cards size to large: 1 (xs-12) 2 (sm-6) 2 (md-6) 3 (lg-4) More... | |
| withExtraLargeCardsSize () | |
| Set the cards size to extra large: 1 (xs-12) 1 (sm-12) 2 (md-6) 2 (lg-6) More... | |
| withFullSizedCardsSize () | |
| Set the cards size to full: More... | |
| getCardsSize () | |
| Get the cards size. More... | |
| 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... | |
Data Fields | |
| const | SIZE_XS = 1 |
| Different sizes of the card. More... | |
| const | SIZE_S = 2 |
| const | SIZE_M = 3 |
| const | SIZE_L = 4 |
| const | SIZE_XL = 6 |
| const | SIZE_FULL = 12 |
Detailed Description
Member Function Documentation
◆ getCards()
| ILIAS\UI\Component\Deck\Deck::getCards | ( | ) |
◆ getCardsSize()
| ILIAS\UI\Component\Deck\Deck::getCardsSize | ( | ) |
Get the cards size.
Note that this size tells how much space the card is using. The number of cards displayed by normal screen size is 12/size.
◆ withCards()
| ILIAS\UI\Component\Deck\Deck::withCards | ( | array | $cards | ) |
Set the cards to be displayed in the deck.
- Parameters
-
◆ withExtraLargeCardsSize()
| ILIAS\UI\Component\Deck\Deck::withExtraLargeCardsSize | ( | ) |
Set the cards size to extra large: 1 (xs-12) 1 (sm-12) 2 (md-6) 2 (lg-6)
◆ withExtraSmallCardsSize()
| ILIAS\UI\Component\Deck\Deck::withExtraSmallCardsSize | ( | ) |
Set the cards size to extra small: 3 (xs-4) 6 (sm-2) 6 (md-2) 12 (lg-1)
◆ withFullSizedCardsSize()
| ILIAS\UI\Component\Deck\Deck::withFullSizedCardsSize | ( | ) |
Set the cards size to full:
- 1 Cards on all screen sizes
◆ withLargeCardsSize()
| ILIAS\UI\Component\Deck\Deck::withLargeCardsSize | ( | ) |
Set the cards size to large: 1 (xs-12) 2 (sm-6) 2 (md-6) 3 (lg-4)
◆ withNormalCardsSize()
| ILIAS\UI\Component\Deck\Deck::withNormalCardsSize | ( | ) |
Set the cards size to normal: 1 (xs-12) 2 (sm-6) 3 (md-4) 4 (lg-3)
◆ withSmallCardsSize()
| ILIAS\UI\Component\Deck\Deck::withSmallCardsSize | ( | ) |
Set the cards size to small: 2 (xs-6) 4 (sm-3) 4 (md-3) 6 (lg-2)
Field Documentation
◆ SIZE_FULL
◆ SIZE_L
| const ILIAS\UI\Component\Deck\Deck::SIZE_L = 4 |
Definition at line 45 of file Deck.php.
Referenced by ILIAS\UI\Implementation\Component\Deck\Renderer\render().
◆ SIZE_M
| const ILIAS\UI\Component\Deck\Deck::SIZE_M = 3 |
Definition at line 44 of file Deck.php.
Referenced by ILIAS\UI\Implementation\Component\Deck\Renderer\render().
◆ SIZE_S
| const ILIAS\UI\Component\Deck\Deck::SIZE_S = 2 |
Definition at line 43 of file Deck.php.
Referenced by ILIAS\UI\Implementation\Factory\deck(), and ILIAS\UI\Implementation\Component\Deck\Renderer\render().
◆ SIZE_XL
◆ SIZE_XS
| const ILIAS\UI\Component\Deck\Deck::SIZE_XS = 1 |
Different sizes of the card.
Those values will be returned by getCardsSize.
Rationale
(1) Breakpoints: 768 - 992 - 1200 (2) Center Points: 384 (xs) - 880 (sm) - 1096 (md) - 1400 (lg) (3) Normalized Ratio: 27% (xs) - 63% (sm) - 78% (md) - 100% (lg) (4) Card sizes respecting ratio: Extra Small: 3 (xs-4) 6 (sm-2) 6 (md-2) 12 (lg-1) Small: 2 (xs-6) 4 (sm-3) 4 (md-3) 6 (lg-2) Normal: 1 (xs-12) 2 (sm-6) 3 (md-4) 4 (lg-3) Large: 1 (xs-12) 2 (sm-6) 2 (md-6) 3 (lg-4) Extra Large: 1 (xs-12) 1 (sm-12) 2 (md-6) 2 (lg-6)
Definition at line 42 of file Deck.php.
Referenced by ILIAS\UI\Implementation\Component\Deck\Renderer\render().
The documentation for this interface was generated from the following file:
- components/ILIAS/UI/src/Component/Deck/Deck.php
