@aurodesignsystem/auro-dropdown
Advanced tools
Comparing version 2.10.0 to 2.10.1
# Semantic Release Automated Changelog | ||
## [2.10.1](https://github.com/AlaskaAirlines/auro-dropdown/compare/v2.10.0...v2.10.1) (2024-01-31) | ||
### Bug Fixes | ||
* **docs:** update doc styles to use --ds ([1e030a8](https://github.com/AlaskaAirlines/auro-dropdown/commit/1e030a87c0c7f02ac7ff665cb5671696a488da06)) | ||
### Performance Improvements | ||
* alaskaairux ref updates ([eac253b](https://github.com/AlaskaAirlines/auro-dropdown/commit/eac253b4ed1383258e7804efa694090025e58345)) | ||
# [2.10.0](https://github.com/AlaskaAirlines/auro-dropdown/compare/v2.9.11...v2.10.0) (2024-01-23) | ||
@@ -4,0 +16,0 @@ |
@@ -0,3 +1,4 @@ | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../api.md) --> | ||
<!-- The below content is automatically added from ./../api.md --> | ||
# auro-dropdown | ||
@@ -60,2 +61,3 @@ | ||
| [trigger](#trigger) | The trigger content container. | | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
@@ -69,2 +71,4 @@ ## API Examples | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/basic.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/basic.html --> | ||
<auro-dropdown aria-label="custom label"> | ||
@@ -76,5 +80,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/basic.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/basic.html --> | ||
@@ -89,5 +96,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/basicIcon.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/basicIcon.html --> | ||
<auro-dropdown aria-label="custom label"> | ||
@@ -101,5 +110,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/basicIcon.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/basicIcon.html --> | ||
@@ -116,5 +128,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/basicButton.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/basicButton.html --> | ||
<auro-dropdown aria-label="custom label"> | ||
@@ -130,5 +144,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/basicButton.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/basicButton.html --> | ||
@@ -147,5 +164,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/basicInput.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/basicInput.html --> | ||
<auro-dropdown aria-label="custom label"> | ||
@@ -161,5 +180,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/basicInput.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/basicInput.html --> | ||
@@ -178,3 +200,3 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -184,3 +206,3 @@ | ||
#### <a name="bordered"></a>bordered | ||
#### bordered | ||
@@ -190,2 +212,4 @@ Adds the border style around the dropdown trigger. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/bordered.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/bordered.html --> | ||
<auro-dropdown aria-label="custom label" bordered> | ||
@@ -197,5 +221,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/bordered.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/bordered.html --> | ||
@@ -210,6 +237,6 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
#### <a name="chevron"></a>chevron | ||
#### chevron | ||
@@ -219,2 +246,4 @@ Adds the bib visibility state chevron to the right side of the trigger content. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/chevron.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/chevron.html --> | ||
<auro-dropdown aria-label="custom label" chevron> | ||
@@ -226,5 +255,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/chevron.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/chevron.html --> | ||
@@ -239,5 +271,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/chevronIcon.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/chevronIcon.html --> | ||
<auro-dropdown aria-label="custom label" chevron> | ||
@@ -251,5 +285,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/chevronIcon.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/chevronIcon.html --> | ||
@@ -266,5 +303,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/chevronButton.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/chevronButton.html --> | ||
<auro-dropdown aria-label="custom label" chevron> | ||
@@ -280,5 +319,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/chevronButton.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/chevronButton.html --> | ||
@@ -297,5 +339,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/chevronInput.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/chevronInput.html --> | ||
<auro-dropdown aria-label="custom label" chevron> | ||
@@ -310,5 +354,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/chevronInput.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/chevronInput.html --> | ||
@@ -326,6 +373,6 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
#### <a name="disabled"></a>disabled | ||
#### disabled | ||
@@ -335,2 +382,4 @@ Disables the trigger preventing the dropdown bib from being shown. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/disabled.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/disabled.html --> | ||
<auro-dropdown aria-label="custom label" disabled> | ||
@@ -342,5 +391,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/disabled.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/disabled.html --> | ||
@@ -355,5 +407,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/disabledAll.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/disabledAll.html --> | ||
<auro-dropdown | ||
@@ -377,5 +431,8 @@ aria-label="custom label" | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/disabledAll.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/disabledAll.html --> | ||
@@ -402,6 +459,6 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
#### <a name="error"></a>error | ||
#### error | ||
@@ -411,2 +468,4 @@ Adds the error state UI to the trigger. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/error.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/error.html --> | ||
<auro-dropdown aria-label="custom label" error> | ||
@@ -418,5 +477,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/error.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/error.html --> | ||
@@ -431,5 +493,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/errorBordered.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/errorBordered.html --> | ||
<auro-dropdown | ||
@@ -446,5 +510,8 @@ aria-label="custom label" | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/errorBordered.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/errorBordered.html --> | ||
@@ -464,6 +531,6 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
#### <a name="inset"></a>inset | ||
#### inset | ||
@@ -473,2 +540,4 @@ The `inset` property applies a predefined amount of CSS `padding` to the `trigger` slot content. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/inset.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/inset.html --> | ||
<auro-dropdown aria-label="custom label" inset> | ||
@@ -480,5 +549,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/inset.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/inset.html --> | ||
@@ -493,5 +565,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/insetBordered.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/insetBordered.html --> | ||
<auro-dropdown | ||
@@ -507,5 +581,8 @@ aria-label="custom label" | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/insetBordered.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/insetBordered.html --> | ||
@@ -524,6 +601,6 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
#### <a name="rounded"></a>rounded | ||
#### rounded | ||
@@ -533,2 +610,4 @@ The `rounded` property applies `border-radius` CSS to the trigger and default slot content. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/rounded.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/rounded.html --> | ||
<auro-dropdown | ||
@@ -543,5 +622,8 @@ aria-label="custom label" | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/rounded.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/rounded.html --> | ||
@@ -559,6 +641,6 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
#### <a name="noToggle"></a>noToggle | ||
#### noToggle | ||
@@ -568,2 +650,4 @@ In cases where it is desired behavior for `auro-dropdown` to only show, not toggle, the bib content when activating the trigger the `noToggle` attribute must be applied. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/noToggle.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/noToggle.html --> | ||
<auro-dropdown aria-label="custom label" noToggle> | ||
@@ -575,5 +659,8 @@ Lorem ipsum solar | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/noToggle.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/noToggle.html --> | ||
@@ -588,3 +675,3 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -594,7 +681,7 @@ | ||
#### <a name="trigger"></a>trigger & default | ||
#### trigger & default | ||
All examples shown on this page include default and `trigger` slot content. | ||
#### <a name="label"></a>label | ||
#### label | ||
@@ -604,2 +691,4 @@ Content defined in the `label` slot will be rendered left aligned inside the trigger above all other defined trigger slot content. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/label.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/label.html --> | ||
<auro-dropdown | ||
@@ -616,5 +705,8 @@ bordered | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/label.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/label.html --> | ||
@@ -634,6 +726,6 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
#### <a name="helpText"></a>helpText | ||
#### helpText | ||
@@ -643,2 +735,4 @@ Content defined in the `helpText` slot will be rendered left aligned below the trigger. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/helpText.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/helpText.html --> | ||
<auro-dropdown | ||
@@ -657,5 +751,8 @@ aria-label="custom label" | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/helpText.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/helpText.html --> | ||
@@ -677,3 +774,3 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -686,2 +783,4 @@ | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/helpTextError.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/helpTextError.html --> | ||
<auro-dropdown | ||
@@ -701,5 +800,8 @@ aria-label="custom label" | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/helpTextError.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/helpTextError.html --> | ||
@@ -722,3 +824,3 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -728,3 +830,3 @@ | ||
#### <a name="show"></a>show | ||
#### show | ||
@@ -734,2 +836,4 @@ The `show` method may also be called from anywhere in your code by executing `document.querySelector('#idOfTheDropdownElement').show()`. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/programmaticallyShow.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/programmaticallyShow.html --> | ||
<auro-input id="showExampleTriggerInput" required> | ||
@@ -744,5 +848,8 @@ <span slot="label">Enter a value to show the dropdown</span> | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/programmaticallyShow.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/programmaticallyShow.html --> | ||
@@ -760,2 +867,5 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/programmaticallyShow.js) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/programmaticallyShow.js --> | ||
@@ -770,6 +880,6 @@ ```js | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
#### <a name="hide"></a>hide | ||
#### hide | ||
@@ -781,2 +891,4 @@ The `hide` method can be called from within the default slot content. This is useful for cases such as `auro-select`. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/programmaticallyHide.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/programmaticallyHide.html --> | ||
<auro-dropdown id="hideExample" aria-label="custom label" rounded bordered inset> | ||
@@ -794,5 +906,8 @@ <p> | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/programmaticallyHide.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/programmaticallyHide.html --> | ||
@@ -813,3 +928,3 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -820,3 +935,3 @@ </auro-accordion> | ||
#### <a name="Width"></a>Width inheritance | ||
#### Width inheritance | ||
@@ -826,2 +941,4 @@ `auro-dropdown` will consume all available width of the parent container. `auro-dropdown` can be made narrower by wrapping it in a container of the desired width. | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/customDimensions100.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/customDimensions100.html --> | ||
<div style="width: 100px;" aria-label="custom label"> | ||
@@ -845,5 +962,8 @@ <auro-dropdown inset bordered rounded chevron> | ||
</div> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/customDimensions100.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/customDimensions100.html --> | ||
@@ -870,5 +990,7 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/customDimensions300.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/customDimensions300.html --> | ||
<div style="width: 300px;" aria-label="custom label"> | ||
@@ -892,5 +1014,8 @@ <auro-dropdown inset bordered rounded chevron> | ||
</div> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/customDimensions300.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/customDimensions300.html --> | ||
@@ -917,3 +1042,3 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> |
@@ -11,8 +11,13 @@ <!-- | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./description.md) --> | ||
<!-- The below content is automatically added from ./description.md --> | ||
The `auro-dropdown` component is a trigger and dropdown element combination intended to be used with dropdown content that is interactive. `auro-dropdown` is content agnostic and any valid HTML can be placed in either the trigger or the dropdown. | ||
_Note: if the dropdown content in your implementation is not interactive (e.g. a tooltip) [auro-popover](http://auro.alaskaair.com/components/auro/popover) may better serve your needs._ | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
## Dropdown use cases | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./useCases.md) --> | ||
<!-- The below content is automatically added from ./useCases.md --> | ||
The `auro-dropdown` element should be used in situations where users may: | ||
@@ -23,2 +28,3 @@ | ||
* when interactive help is required | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
@@ -40,4 +46,6 @@ ## Accessibility support | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/common.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/common.html --> | ||
<auro-dropdown id="common" common aria-label="Label content for screen reader"> | ||
<div style="padding: var(--auro-size-sm);"> | ||
<div style="padding: var(--ds-size-150);"> | ||
Lorem ipsum solar | ||
@@ -56,9 +64,12 @@ <br /> | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/common.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/common.html --> | ||
```html | ||
<auro-dropdown id="common" common aria-label="Label content for screen reader"> | ||
<div style="padding: var(--auro-size-sm);"> | ||
<div style="padding: var(--ds-size-150);"> | ||
Lorem ipsum solar | ||
@@ -78,3 +89,3 @@ <br /> | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -87,5 +98,7 @@ | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/commonLabelledby.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/commonLabelledby.html --> | ||
<p id="foo">The element is labelled by content external to the element.</p> | ||
<auro-dropdown id="commonAdvanced" aria-labelledby="foo" bordered rounded inset chevron> | ||
<div style="padding: var(--auro-size-sm);"> | ||
<div style="padding: var(--ds-size-150);"> | ||
Lorem ipsum solar | ||
@@ -104,5 +117,8 @@ <br /> | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/commonLabelledby.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/commonLabelledby.html --> | ||
@@ -112,3 +128,3 @@ ```html | ||
<auro-dropdown id="commonAdvanced" aria-labelledby="foo" bordered rounded inset chevron> | ||
<div style="padding: var(--auro-size-sm);"> | ||
<div style="padding: var(--ds-size-150);"> | ||
Lorem ipsum solar | ||
@@ -128,3 +144,3 @@ <br /> | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -137,4 +153,6 @@ | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/commonSlot.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/commonSlot.html --> | ||
<auro-dropdown id="commonSlot" bordered rounded inset chevron> | ||
<div style="padding: var(--auro-size-sm);"> | ||
<div style="padding: var(--ds-size-150);"> | ||
Lorem ipsum solar | ||
@@ -156,9 +174,12 @@ <br /> | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/commonSlot.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/commonSlot.html --> | ||
```html | ||
<auro-dropdown id="commonSlot" bordered rounded inset chevron> | ||
<div style="padding: var(--auro-size-sm);"> | ||
<div style="padding: var(--ds-size-150);"> | ||
Lorem ipsum solar | ||
@@ -181,3 +202,3 @@ <br /> | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -190,5 +211,7 @@ | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/widerPopover.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/widerPopover.html --> | ||
<div style="width: 250px;"> | ||
<auro-dropdown common aria-label="Label content for screen reader"> | ||
<div style="padding: var(--auro-size-sm); width: 500px;"> | ||
<div style="padding: var(--ds-size-150); width: 500px;"> | ||
This is special content. | ||
@@ -204,5 +227,8 @@ </div> | ||
</div> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/widerPopover.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/widerPopover.html --> | ||
@@ -212,3 +238,3 @@ ```html | ||
<auro-dropdown common aria-label="Label content for screen reader"> | ||
<div style="padding: var(--auro-size-sm); width: 500px;"> | ||
<div style="padding: var(--ds-size-150); width: 500px;"> | ||
This is special content. | ||
@@ -225,3 +251,3 @@ </div> | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -234,4 +260,6 @@ | ||
<div class="exampleWrapper"> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/commonMatchWidth.html) --> | ||
<!-- The below content is automatically added from ./../../apiExamples/commonMatchWidth.html --> | ||
<auro-dropdown id="common" common matchWidth aria-label="Label content for screen reader"> | ||
<div style="padding: var(--auro-size-sm);"> | ||
<div style="padding: var(--ds-size-150);"> | ||
Lorem ipsum solar | ||
@@ -250,9 +278,12 @@ <br /> | ||
</auro-dropdown> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</div> | ||
<auro-accordion lowProfile justifyRight> | ||
<auro-accordion alignRight> | ||
<span slot="trigger">See code</span> | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/commonMatchWidth.html) --> | ||
<!-- The below code snippet is automatically added from ./../../apiExamples/commonMatchWidth.html --> | ||
```html | ||
<auro-dropdown id="common" common matchWidth aria-label="Label content for screen reader"> | ||
<div style="padding: var(--auro-size-sm);"> | ||
<div style="padding: var(--ds-size-150);"> | ||
Lorem ipsum solar | ||
@@ -272,3 +303,3 @@ <br /> | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
</auro-accordion> | ||
@@ -275,0 +306,0 @@ |
@@ -10,3 +10,3 @@ { | ||
"name": "@aurodesignsystem/auro-dropdown", | ||
"version": "2.10.0", | ||
"version": "2.10.1", | ||
"description": "auro-dropdown HTML custom element", | ||
@@ -13,0 +13,0 @@ "repository": { |
<!-- | ||
The README.md file is a compiled document. No edits should be made directly to this file. | ||
README.md is created by running `npm run build:markdownDocs`. | ||
README.md is created by running `npm run build:docs`. | ||
@@ -22,16 +22,26 @@ This file is generated based on a template fetched from | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) --> | ||
<!-- The below content is automatically added from ./../docs/partials/description.md --> | ||
The `auro-dropdown` component is a trigger and dropdown element combination intended to be used with dropdown content that is interactive. `auro-dropdown` is content agnostic and any valid HTML can be placed in either the trigger or the dropdown. | ||
_Note: if the dropdown content in your implementation is not interactive (e.g. a tooltip) [auro-popover](http://auro.alaskaair.com/components/auro/popover) may better serve your needs._ | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/readmeAddlInfo.md) --> | ||
<!-- The below content is automatically added from ./../docs/partials/readmeAddlInfo.md --> | ||
<!-- AURO-GENERATED-CONTENT This file is to be used for any additional content that should be included in the README.md which is specific to this component. --> | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
## UI development browser support | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) --> | ||
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport) | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
## Install | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall.md) --> | ||
[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-dropdown/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-dropdown/actions/workflows/testPublish.yml) | ||
[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-dropdown?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-dropdown) | ||
[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-dropdown?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0) | ||
[![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/@aurodesignsystem/auro-dropdown?style=for-the-badge)](https://snyk.io/test/npm/@aurodesignsystem/auro-dropdown?tab=issues) | ||
@@ -44,8 +54,14 @@ ```shell | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### Design Token CSS Custom Property dependency | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) --> | ||
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens). | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### CSS Custom Property fallbacks | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/cssFallbacks.md) --> | ||
[CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) are [not supported](https://auro.alaskaair.com/support/custom-properties) in older browsers. For this, fallback properties are pre-generated and included with the npm. | ||
@@ -55,6 +71,12 @@ | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### Define dependency in project component | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) --> | ||
Defining the component dependency within each component that is using the `<auro-dropdown>` component. | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) --> | ||
```js | ||
@@ -64,3 +86,6 @@ import "@aurodesignsystem/auro-dropdown"; | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
**Reference component in HTML** | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) --> | ||
<!-- The below code snippet is automatically added from ./../apiExamples/basic.html --> | ||
@@ -75,11 +100,19 @@ ```html | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
## CDN Use | ||
## Install bundled assets from CDN | ||
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) --> | ||
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-dropdown__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported. | ||
### Install | ||
Include the following example HTML code in the `<head>` element of your page. | ||
We recommend you load these bundles using [differential serving](https://philipwalton.com/articles/deploying-es2015-code-in-production-today/) so that the browser only loads the bundle correctly. To accomplish this, the script tag for the modern bundle should have `type="module"` and the script tag. | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### Bundle example code | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUse.md) --> | ||
```html | ||
<!-- **NOTE:** Be sure to replace `@latest` in the URL with the version of the asset you want. @latest is NOT aware of any MAJOR releases, use at your own risk. --> | ||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css" /> | ||
@@ -90,10 +123,8 @@ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/essentials.css" /> | ||
**NOTE:** Be sure to replace `@latest` in the URL with the version of the asset you want. @latest is NOT aware of any MAJOR releases, use at your own risk. | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### CDN options | ||
Both [Unpkg](https://www.unpkg.com/) and [JSDelivr](https://www.jsdelivr.com/) are free open source options that you can use. These are 3rd party resources and Auro is not responsible for their uptime. **Use at your own risk.** These bundle resources are included with the npm package, you are free to use any CDN resource that fits your needs. | ||
## auro-dropdown use cases | ||
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/useCases.md) --> | ||
<!-- The below content is automatically added from ./../docs/partials/useCases.md --> | ||
The `auro-dropdown` element should be used in situations where users may: | ||
@@ -104,2 +135,3 @@ | ||
* when interactive help is required | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
@@ -110,2 +142,5 @@ ## API Code Examples | ||
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) --> | ||
<!-- The below code snippet is automatically added from ./../apiExamples/basic.html --> | ||
```html | ||
@@ -119,5 +154,7 @@ <auro-dropdown aria-label="custom label"> | ||
``` | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
## Development | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/developmentDescription.md) --> | ||
In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request. | ||
@@ -127,4 +164,7 @@ | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### Start development environment | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/localhost.md) --> | ||
Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the **dev server**. | ||
@@ -146,17 +186,23 @@ | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### API generation | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/api.md) --> | ||
The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control. | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### Testing | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) --> | ||
Automated tests are required for every Auro component. See `.\test\auro-dropdown.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details. | ||
<!-- AURO-GENERATED-CONTENT:END --> | ||
### Bundled assets | ||
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/bundles.md) --> | ||
Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run `$ npm run bundler` to generate assets. | ||
### Demo deployment | ||
To deploy a demo version of the component for review, run `npm run build:demo` to create a `./build` directory that can be pushed to any static server. | ||
<!-- AURO-GENERATED-CONTENT:END --> |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
212178
198