@aurodesignsystem/auro-formkit 2.0.0-beta.50 → 2.0.0-beta.52

package/components/select/demo/api.md

@@ -14,21 +14,23 @@ The auro-select element is a wrapper for auro-dropdown and auro-menu to create a
 
 ## Properties
 
-| Property                        | Attribute                       | Type      | Default     | Description                                      |
-|---------------------------------|---------------------------------|-----------|-------------|--------------------------------------------------|
-| [disabled](#disabled)                      | `disabled`                      | `boolean` |             | When attribute is present, element shows disabled state. |
-| [error](#error)                         | `error`                         | `string`  |             | When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value. |
-| [flexMenuWidth](#flexMenuWidth)                 | `flexMenuWidth`                 | `boolean` |             | If set, makes dropdown width match the size of the content, rather than the width of the trigger. |
-| [multiSelect](#multiSelect)                   | `multiselect`                   | `boolean` |             | Sets multi-select mode, allowing multiple options to be selected at once. |
-| [noCheckmark](#noCheckmark)                   | `noCheckmark`                   | `boolean` |             | When true, checkmark on selected option will no longer be present. |
-| [noValidate](#noValidate)                    | `noValidate`                    | `boolean` |             | If set, disables auto-validation on blur.        |
-| [optionSelected](#optionSelected)                | `optionSelected`                |           | "undefined" | Specifies the current selected menuOption.       |
-| [required](#required)                      | `required`                      | `boolean` |             | Populates the `required` attribute on the element. Used for client-side validation. |
-| [setCustomValidity](#setCustomValidity)             | `setCustomValidity`             | `string`  |             | Sets a custom help text message to display for all validityStates. |
-| [setCustomValidityCustomError](#setCustomValidityCustomError)  | `setCustomValidityCustomError`  | `string`  |             | Custom help text message to display when validity = `customError`. |
-| [setCustomValidityValueMissing](#setCustomValidityValueMissing) | `setCustomValidityValueMissing` | `string`  |             | Custom help text message to display when validity = `valueMissing`. |
-| [validity](#validity)                      | `validity`                      | `string`  |             | Specifies the `validityState` this element is in. |
-| [value](#value)                         | `value`                         |           | "undefined" | Value selected for the component.                |
+| Property                        | Attribute                       | Type      | Default | Description                                      |
+|---------------------------------|---------------------------------|-----------|---------|--------------------------------------------------|
+| [disabled](#disabled)                      | `disabled`                      | `boolean` |         | When attribute is present, element shows disabled state. |
+| [error](#error)                         | `error`                         | `string`  |         | When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value. |
+| [flexMenuWidth](#flexMenuWidth)                 | `flexMenuWidth`                 | `boolean` |         | If set, makes dropdown width match the size of the content, rather than the width of the trigger. |
+| [fullscreenBreakpoint](#fullscreenBreakpoint)          | `fullscreenBreakpoint`          | `string`  | "sm"    | Defines the screen size breakpoint (`lg`, `md`, `sm`, or `xs`) at which the dropdown switches to fullscreen mode on mobile.<br />When expanded, the dropdown will automatically display in fullscreen mode if the screen size is equal to or smaller than the selected breakpoint. |
+| [largeFullscreenHeadline](#largeFullscreenHeadline)       | `largeFullscreenHeadline`       | `boolean` |         | If declared, make bib.fullscreen.headline in HeadingDisplay.<br />Otherwise, Heading 600 |
+| [multiSelect](#multiSelect)                   | `multiselect`                   | `boolean` |         | Sets multi-select mode, allowing multiple options to be selected at once. |
+| [noCheckmark](#noCheckmark)                   | `noCheckmark`                   | `boolean` |         | When true, checkmark on selected option will no longer be present. |
+| [noValidate](#noValidate)                    | `noValidate`                    | `boolean` |         | If set, disables auto-validation on blur.        |
+| [optionSelected](#optionSelected)                | `optionSelected`                |           |         | Specifies the current selected menuOption.       |
+| [required](#required)                      | `required`                      | `boolean` |         | Populates the `required` attribute on the element. Used for client-side validation. |
+| [setCustomValidity](#setCustomValidity)             | `setCustomValidity`             | `string`  |         | Sets a custom help text message to display for all validityStates. |
+| [setCustomValidityCustomError](#setCustomValidityCustomError)  | `setCustomValidityCustomError`  | `string`  |         | Custom help text message to display when validity = `customError`. |
+| [setCustomValidityValueMissing](#setCustomValidityValueMissing) | `setCustomValidityValueMissing` | `string`  |         | Custom help text message to display when validity = `valueMissing`. |
+| [validity](#validity)                      | `validity`                      | `string`  |         | Specifies the `validityState` this element is in. |
+| [value](#value)                         | `value`                         |           |         | Value selected for the component.                |
 
 ## Methods
 
@@ -47,12 +49,13 @@ The auro-select element is a wrapper for auro-dropdown and auro-menu to create a
 
 ## Slots
 
-| Name          | Description                                      |
-|---------------|--------------------------------------------------|
-|               | Default slot for the menu content.               |
-| [helpText](#helpText)    | Defines the content of the helpText.             |
-| [label](#label)       | Defines the content of the label.                |
-| [placeholder](#placeholder) | Defines the content of the placeholder to be shown when there is no value |
+| Name                      | Description                                      |
+|---------------------------|--------------------------------------------------|
+|                           | Default slot for the menu content.               |
+| `bib.fullscreen.headline` | Defines the headline to display above menu-options |
+| [helpText](#helpText)                | Defines the content of the helpText.             |
+| [label](#label)                   | Defines the content of the label.                |
+| [placeholder](#placeholder)             | Defines the content of the placeholder to be shown when there is no value |
 
 ## CSS Shadow Parts
 
@@ -71,6 +74,7 @@ A baseline `auro-select` using `auro-menu` and `auro-menuoption` elements.
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
   <!-- The below content is automatically added from ./../apiExamples/basic.html -->
   <auro-select>
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <auro-menu>
       <auro-menuoption value="stops">Stops</auro-menuoption>
       <auro-menuoption value="price">Price</auro-menuoption>
@@ -89,6 +93,7 @@ A baseline `auro-select` using `auro-menu` and `auro-menuoption` elements.
 
 ```html
 <auro-select>
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <auro-menu>
     <auro-menuoption value="stops">Stops</auro-menuoption>
     <auro-menuoption value="price">Price</auro-menuoption>
@@ -116,6 +121,7 @@ To pre-set the value of auro-select on load, use the `value` property. The `sele
   <auro-button id="invalidValueExampleBtn">Set Value to Invalid Option</auro-button>
   <br/><br/>
   <auro-select id="valueExample" value='["price"]'>
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <span slot="label">Name</span>
     <auro-menu>
       <auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
@@ -138,6 +144,7 @@ To pre-set the value of auro-select on load, use the `value` property. The `sele
 <auro-button id="invalidValueExampleBtn">Set Value to Invalid Option</auro-button>
 <br/><br/>
 <auro-select id="valueExample" value='["price"]'>
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <span slot="label">Name</span>
   <auro-menu>
     <auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
@@ -178,6 +185,7 @@ When the validity check fails the validityState, equals `valueMissing`. The erro
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/required.html) -->
   <!-- The below content is automatically added from ./../apiExamples/required.html -->
   <auro-select required setCustomValidityValueMissing="Custom required validation error message.">
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <auro-menu>
       <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -197,6 +205,7 @@ When the validity check fails the validityState, equals `valueMissing`. The erro
 
 ```html
 <auro-select required setCustomValidityValueMissing="Custom required validation error message.">
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <auro-menu>
     <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -223,6 +232,7 @@ A custom error message can be set using the `error` attribute, or it can be used
   <auro-button id="undefinedValueExampleBtnRemoveError">Remove Error</auro-button>
   <br /><br />
   <auro-select id="errorExample" error="Custom error message">
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <auro-menu>
       <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -245,6 +255,7 @@ A custom error message can be set using the `error` attribute, or it can be used
 <auro-button id="undefinedValueExampleBtnRemoveError">Remove Error</auro-button>
 <br /><br />
 <auro-select id="errorExample" error="Custom error message">
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <auro-menu>
     <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -266,6 +277,7 @@ Use the `disabled` boolean attribute to toggle the disabled UI.
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled.html) -->
   <!-- The below content is automatically added from ./../apiExamples/disabled.html -->
   <auro-select disabled>
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <auro-menu>
       <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -285,6 +297,7 @@ Use the `disabled` boolean attribute to toggle the disabled UI.
 
 ```html
 <auro-select disabled>
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <auro-menu>
     <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -306,6 +319,7 @@ Sets multi-select mode, allowing multiple options to be selected at once.
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/multiselect.html) -->
   <!-- The below content is automatically added from ./../apiExamples/multiselect.html -->
   <auro-select multiselect>
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Select one or more options</label>
     <auro-menu>
       <auro-menuoption value="1">Option 1</auro-menuoption>
@@ -322,6 +336,7 @@ Sets multi-select mode, allowing multiple options to be selected at once.
 
 ```html
 <auro-select multiselect>
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Select one or more options</label>
   <auro-menu>
     <auro-menuoption value="1">Option 1</auro-menuoption>
@@ -340,6 +355,7 @@ Use the `flexMenuWidth` boolean attribute to toggle the width of the `<auro-sele
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/flexMenuWidth.html) -->
   <!-- The below content is automatically added from ../apiExamples/flexMenuWidth.html -->
   <auro-select flexMenuWidth id="flexMenuWidthExample">
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <auro-menu>
       <auro-menuoption value="united states">United States has a country code of (+1)</auro-menuoption>
@@ -363,6 +379,7 @@ Use the `flexMenuWidth` boolean attribute to toggle the width of the `<auro-sele
 
 ```html
 <auro-select flexMenuWidth id="flexMenuWidthExample">
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <auro-menu>
     <auro-menuoption value="united states">United States has a country code of (+1)</auro-menuoption>
@@ -390,6 +407,7 @@ Use the `label` slot to give your users contextual information about their selec
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/label.html) -->
   <!-- The below content is automatically added from ./../apiExamples/label.html -->
   <auro-select>
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <span slot="label">Please select a preference</span>
     <auro-menu>
       <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -409,6 +427,7 @@ Use the `label` slot to give your users contextual information about their selec
 
 ```html
 <auro-select>
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <span slot="label">Please select a preference</span>
   <auro-menu>
     <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -430,6 +449,7 @@ Use the `helptext` slot to provide additional information back to your user abou
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/helpText.html) -->
   <!-- The below content is automatically added from ./../apiExamples/helpText.html -->
   <auro-select>
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <span slot="helpText">Custom help text message.</span>
     <auro-menu>
@@ -450,6 +470,7 @@ Use the `helptext` slot to provide additional information back to your user abou
 
 ```html
 <auro-select>
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <span slot="helpText">Custom help text message.</span>
   <auro-menu>
@@ -477,6 +498,7 @@ Use the `reset()` method to reset the `<auro-select>`'s `value` and `validity` s
   <auro-button id="resetStateBtn">Reset</auro-button>
   <br/><br/>
   <auro-select id="resetStateExample" value='["price"]'>
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <span slot="label">Name</span>
     <auro-menu>
@@ -499,6 +521,7 @@ Use the `reset()` method to reset the `<auro-select>`'s `value` and `validity` s
 <auro-button id="resetStateBtn">Reset</auro-button>
 <br/><br/>
 <auro-select id="resetStateExample" value='["price"]'>
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <span slot="label">Name</span>
   <auro-menu>
@@ -535,6 +558,7 @@ The following example illustrates how a user may query the `element.value` or `e
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/valueExtraction.html) -->
   <!-- The below content is automatically added from ./../apiExamples/valueExtraction.html -->
   <auro-select id="valueExtraction">
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <auro-menu>
       <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -555,6 +579,7 @@ The following example illustrates how a user may query the `element.value` or `e
 
 ```html
 <auro-select id="valueExtraction">
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <auro-menu>
     <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -595,6 +620,7 @@ This example programmatically adds the `error` state when a user selects an opti
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/customErrorValidity.html) -->
   <!-- The below content is automatically added from ./../apiExamples/customErrorValidity.html -->
   <auro-select id="primaryError">
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <auro-menu>
       <auro-menuoption value="1">1</auro-menuoption>
@@ -614,6 +640,7 @@ This example programmatically adds the `error` state when a user selects an opti
 
 ```html
 <auro-select id="primaryError">
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <auro-menu>
     <auro-menuoption value="1">1</auro-menuoption>
@@ -652,6 +679,7 @@ While content is loading, the menu can either remain empty or display a loading
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/loading.html) -->
   <!-- The below content is automatically added from ./../apiExamples/loading.html -->
   <auro-select id="loadingExample">
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <span slot="label">Please select a preference</span>
     <auro-menu id="loadingExampleSelectMenu">
       <auro-loader slot="loadingIcon" orbit xs></auro-loader><span slot="loadingText">Loading...</span>
@@ -702,6 +730,7 @@ export function auroMenuLoadingExample() {
 
 ```html
 <auro-select id="loadingExample">
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <span slot="label">Please select a preference</span>
   <auro-menu id="loadingExampleSelectMenu">
     <auro-loader slot="loadingIcon" orbit xs></auro-loader><span slot="loadingText">Loading...</span>
@@ -711,6 +740,53 @@ export function auroMenuLoadingExample() {
 <!-- AURO-GENERATED-CONTENT:END -->
 </auro-accordion>
 
+### Dropdown with fullscreen bib
+
+You can make the dropdown open in fullscreen at a specific breakpoint by setting `fullscreenBreakpoint`.
+
+The default value of `fullscreenBreakpoint` is `sm`. 
+
+Breakpoint token can be found [here](https://auro.alaskaair.com/getting-started/developers/design-tokens)
+
+To support fullcreen bib, setting `bib.fullscreen.headline` is **STRONGLY RECOMMENDED**.
+
+<div class="exampleWrapper">
+  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fullscreenBreakpoint.html) -->
+  <!-- The below content is automatically added from ./../apiExamples/fullscreenBreakpoint.html -->
+  <auro-select fullscreenBreakpoint="lg">
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
+    <auro-menu>
+      <auro-menuoption value="stops">Stops</auro-menuoption>
+      <auro-menuoption value="price">Price</auro-menuoption>
+      <auro-menuoption value="duration">Duration</auro-menuoption>
+      <auro-menuoption value="departure">Departure</auro-menuoption>
+      <auro-menuoption value="arrival">Arrival</auro-menuoption>
+      <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
+    </auro-menu>
+  </auro-select>
+  <!-- AURO-GENERATED-CONTENT:END -->
+</div>
+<auro-accordion alignRight>
+  <span slot="trigger">See code</span>
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/fullscreenBreakpoint.html) -->
+<!-- The below code snippet is automatically added from ./../apiExamples/fullscreenBreakpoint.html -->
+
+```html
+<auro-select fullscreenBreakpoint="lg">
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
+  <auro-menu>
+    <auro-menuoption value="stops">Stops</auro-menuoption>
+    <auro-menuoption value="price">Price</auro-menuoption>
+    <auro-menuoption value="duration">Duration</auro-menuoption>
+    <auro-menuoption value="departure">Departure</auro-menuoption>
+    <auro-menuoption value="arrival">Arrival</auro-menuoption>
+    <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
+  </auro-menu>
+</auro-select>
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+</auro-accordion>
+
 #### in Dialog
 
 The component can be in a dialog.
@@ -724,6 +800,7 @@ The component can be in a dialog.
       <span slot="header">Select in Dialog</span>
       <div slot="content">
         <auro-select id="valueExample" value='["price"]'>
+          <span slot="bib.fullscreen.headline">Bib Headline</span>
           <span slot="label">Name</span>
           <auro-menu>
             <auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
@@ -751,6 +828,7 @@ The component can be in a dialog.
     <span slot="header">Select in Dialog</span>
     <div slot="content">
       <auro-select id="valueExample" value='["price"]'>
+        <span slot="bib.fullscreen.headline">Bib Headline</span>
         <span slot="label">Name</span>
         <auro-menu>
           <auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
@@ -788,6 +866,7 @@ The following example listens for the `auroMenu-selectedOption` event. Once trig
   <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/valueAlert.html) -->
   <!-- The below content is automatically added from ./../apiExamples/valueAlert.html -->
   <auro-select id="valueAlert">
+    <span slot="bib.fullscreen.headline">Bib Headline</span>
     <label slot="placeholder">Placeholder Text</label>
     <auro-menu id="valueAlertMenu">
       <auro-menuoption value="stops">Stops</auro-menuoption>
@@ -807,6 +886,7 @@ The following example listens for the `auroMenu-selectedOption` event. Once trig
 
 ```html
 <auro-select id="valueAlert">
+  <span slot="bib.fullscreen.headline">Bib Headline</span>
   <label slot="placeholder">Placeholder Text</label>
   <auro-menu id="valueAlertMenu">
     <auro-menuoption value="stops">Stops</auro-menuoption>