generated from yiisoft/package-template
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f694913
commit a58bbdc
Showing
13 changed files
with
281 additions
and
130 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| # Dropdown widget | ||
|
|
||
| The dropdown widget is a simple widget that allows you to select a single value from a list of options. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```php | ||
| echo Yiisoft\Yii\Widgets\Dropdown::widget() | ||
| ->id('dropdown-example') | ||
| ->items( | ||
| [ | ||
| [ | ||
| 'label' => 'Action', | ||
| 'link' => '#', | ||
| 'items' => [ | ||
| ['label' => 'Action', 'link' => '#'], | ||
| ['label' => 'Another action', 'link' => '#'], | ||
| ['label' => 'Something else here', 'link' => '#'], | ||
| '-', | ||
| ['label' => 'Separated link', 'link' => '#'], | ||
| ], | ||
| ], | ||
| ] | ||
| ) | ||
| ->toggleType('link') | ||
| ->toggleType('split') | ||
| ->render(); | ||
| ``` | ||
|
|
||
| The code above generates the following HTML: | ||
|
|
||
| ```html | ||
| <div class="btn-group"> | ||
| <button type="button" class="btn btn-danger">Action</button> | ||
| <button type="button" id="dropdown-example" class="btn btn-danger dropdown-toggle dropdown-toggle-split" aria-expanded="false" data-bs-toggle="dropdown"><span class="visually-hidden">Action</span></button> | ||
| <ul class="dropdown-menu" aria-labelledby="dropdown-example"> | ||
| <li><a class="dropdown-item" href="#">Action</a></li> | ||
| <li><a class="dropdown-item" href="#">Another action</a></li> | ||
| <li><a class="dropdown-item" href="#">Something else here</a></li> | ||
| <li><hr class="dropdown-divider"></li> | ||
| <li><a class="dropdown-item" href="#">Separated link</a></li> | ||
| </ul> | ||
| </div> | ||
| ``` | ||
|
|
||
| ## Setters | ||
|
|
||
| All setters are immutable and return a new instance of the `Yiisoft\Yii\Widgets\Menu` class with the specified value. | ||
|
|
||
| Method | Description | Default | ||
| -------|-------------|--------- | ||
| `activeCssClass(string $value)` | The CSS class to be added to the active item. | `active` | ||
| `container(bool $value)` | If the container is enabled, or not. | `true` | ||
| `containerAttributes(array $valuesMap)` | The HTML attributes for the container tag. | `[]` | ||
| `containerClass(string $value)` | The CSS class for the container tag. | `''` | ||
| `containerTag(string $value)` | The tag name for the container tag. | `div` | ||
| `disabledClass(string $value)` | The CSS class to be added to the disabled item. | `disabled` | ||
| `dividerAttributes(array $valuesMap)` | The HTML attributes for the divider tag. | `[]` | ||
| `dividerClass(string $value)` | The CSS class for the divider tag. | `dropdown-divider` | ||
| `dividerTag(string $value)` | The tag name for the divider tag. | `hr` | ||
| `headerClass(string $value)` | The CSS class for the header tag. | `''` | ||
| `headerTag(string $value)` | The tag name for the header tag. | `h6` | ||
| `id(string $value)` | The ID of the widget. | `''` | ||
| `itemClass(string $value)` | The CSS class for the item tag. | `dropdown-item` | ||
| `itemContainer(string $value)` | Item container to use. If false, the item container will not be rendered. | `true` | ||
| `itemContainerAttributes(array $valuesMap)` | The HTML attributes for the item container tag. | `[]` | ||
| `itemContainerClass(string $value)` | The CSS class for the item container tag. | `dropdown-menu` | ||
| `itemContainerTag(string $value)` | The tag name for the item container tag. | `ul` | ||
| `itemTag(string $value)` | The tag name for the item tag. | `a` | ||
| `items(array $value)` | List of menu items in the dropdown. | `[]` | ||
| `itemsContainerAttributes(array $valuesMap)` | The HTML attributes for the items container tag. | `[]` | ||
| `itemsContainerClass(string $value)` | The CSS class for the items container tag. | `''` | ||
| `itemsContainerTag(string $value)` | The tag name for the items container tag. | `li` | ||
| `splitButtonAttributes(array $valuesMap)` | The HTML attributes for the split button tag. | `[]` | ||
| `splitButtonClass(string $value)` | The CSS class for the split button tag. | `''` | ||
| `toggleAttributes(array $valuesMap)` | The HTML attributes for the toggle tag. | `[]` | ||
| `toggleClass(string $value)` | The CSS class for the toggle tag. | `''` | ||
| `toggleType(string $value)` | The type of the toggle button. | `button` | ||
|
|
||
| ### Items structure is an array of the following structure: | ||
|
|
||
| ```php | ||
| [ | ||
| [ | ||
| 'label' => '', | ||
| 'active' => false, | ||
| 'disabled' => false, | ||
| 'enclose' => true, | ||
| 'encode' => true, | ||
| 'headerAttributes' => [], | ||
| 'link' => '', | ||
| 'linkAttributes' => [], | ||
| 'icon' => '', | ||
| 'iconAttributes' => [], | ||
| 'items' => [], | ||
| 'itemsContainerAttributes' => [], | ||
| 'visible' => true, | ||
| ], | ||
| ] | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.