@aurodesignsystem-dev/auro-formkit 0.0.0-pr755.0 → 0.0.0-pr756.0

package/components/counter/demo/api.md

@@ -8,6 +8,7 @@
 | Property   | Attribute  | Type      | Default     | Description                                      |
 |------------|------------|-----------|-------------|--------------------------------------------------|
 | [disabled](#disabled) | `disabled` | `boolean` | false       | Indicates if the counter is disabled.            |
+| [error](#error)    | `error`    | `string`  |             | Error state and message.<br />True if set, value is the error message. |
 | [max](#max)      | `max`      | `number`  | 9           | The maximum value for the counter.               |
 | [min](#min)      | `min`      | `number`  | 0           | The minimum value for the counter.               |
 | [onDark](#onDark)   | `onDark`   | `boolean` | false       | If declared, the counter will be rendered with onDark styles. |
@@ -42,6 +43,7 @@
 | Property                  | Attribute                 | Type                     | Default        | Description                                      |
 |---------------------------|---------------------------|--------------------------|----------------|--------------------------------------------------|
 | [autoPlacement](#autoPlacement)           | `autoPlacement`           | `boolean`                | "false"        | If declared, bib's position will be automatically calculated where to appear. |
+| [error](#error)                   | `error`                   | `string`                 |                | The current error message to display when the component is invalid. |
 | [fullscreenBreakpoint](#fullscreenBreakpoint)    | `fullscreenBreakpoint`    | `string`                 | "sm"           | Defines the screen size breakpoint (`xs`, `sm`, `md`, `lg`, `xl`, `disabled`)<br />at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.<br /><br />When expanded, the dropdown will automatically display in fullscreen mode<br />if the screen size is equal to or smaller than the selected breakpoint. |
 | [isDropdown](#isDropdown)              | `isDropdown`              | `boolean`                | false          | Indicates if the counter group is displayed as a dropdown. |
 | [largeFullscreenHeadline](#largeFullscreenHeadline) | `largeFullscreenHeadline` | `boolean`                | false          | If declared, make bib.fullscreen.headline in HeadingDisplay.<br />Otherwise, Heading 600. |
@@ -340,6 +342,131 @@ counter.addEventListener('input', (event) => {
 <!-- AURO-GENERATED-CONTENT:END -->
 </auro-accordion>
 
+### Counter with Custom Error
+
+A custom error can be set on the counter by adding the `error` attribute the desired message.
+
+<div class="exampleWrapper">
+  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/counter-error.html) -->
+  <!-- The below content is automatically added from ./../apiExamples/counter-error.html -->
+  <auro-counter error="There is an error with the counter">
+    Adults
+  </auro-counter>
+  <!-- AURO-GENERATED-CONTENT:END -->
+</div>
+<div class="exampleWrapper--ondark" aria-hidden>
+  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/ondark-counter-error.html) -->
+  <!-- The below content is automatically added from ./../apiExamples/ondark-counter-error.html -->
+  <auro-counter ondark error="There is an error with the counter">
+    Adults
+  </auro-counter>
+  <!-- AURO-GENERATED-CONTENT:END -->
+</div>
+<auro-accordion alignRight>
+  <span slot="trigger">See code</span>
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/counter-error.html) -->
+<!-- The below code snippet is automatically added from ./../apiExamples/counter-error.html -->
+
+```html
+<auro-counter error="There is an error with the counter">
+  Adults
+</auro-counter>
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/ondark-counter-error.html) -->
+<!-- The below content is automatically added from ./../apiExamples/ondark-counter-error.html -->
+<auro-counter ondark error="There is an error with the counter">
+  Adults
+</auro-counter>
+<!-- AURO-GENERATED-CONTENT:END -->
+</auro-accordion>
+
+### Counter Dropdown with Errored Counters
+
+A counter dropdown with counters in an errored state will display the errors for each errored counter by default
+
+<div class="exampleWrapper">
+  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/dropdown-error-basic.html) -->
+  <!-- The below content is automatically added from ./../apiExamples/dropdown-error-basic.html -->
+  <auro-counter-group isDropdown>
+    <div slot="bib.fullscreen.headline">Passengers</div>
+    <div slot="label">Passengers</div>
+    <auro-counter error="Cannot have less than 1 adult passenger">
+      Adults
+      <span slot="description">18 years or older</span>
+    </auro-counter>
+    <auro-counter error="Cannot have more than 2 child passengers">
+      Children
+      <span slot="description">2-17 years</span>
+    </auro-counter>
+  </auro-counter-group>
+  <!-- AURO-GENERATED-CONTENT:END -->
+</div>
+<auro-accordion alignRight>
+  <span slot="trigger">See code</span>
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/dropdown-error-basic.html) -->
+<!-- The below code snippet is automatically added from ./../apiExamples/dropdown-error-basic.html -->
+
+```html
+<auro-counter-group isDropdown>
+  <div slot="bib.fullscreen.headline">Passengers</div>
+  <div slot="label">Passengers</div>
+  <auro-counter error="Cannot have less than 1 adult passenger">
+    Adults
+    <span slot="description">18 years or older</span>
+  </auro-counter>
+  <auro-counter error="Cannot have more than 2 child passengers">
+    Children
+    <span slot="description">2-17 years</span>
+  </auro-counter>
+</auro-counter-group>
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+</auro-accordion>
+
+### Counter Dropdown with Custom Error
+
+The error message for a dropdown counter with errored counters can also be overridden with the `error` attribute.
+
+<div class="exampleWrapper">
+  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/dropdown-error-custom.html) -->
+  <!-- The below content is automatically added from ./../apiExamples/dropdown-error-custom.html -->
+  <auro-counter-group error="Please select the appropriate number of passengers" isDropdown>
+    <div slot="bib.fullscreen.headline">Passengers</div>
+    <div slot="label">Passengers</div>
+    <auro-counter error="Cannot have less than 1 adult passenger">
+      Adults
+      <span slot="description">18 years or older</span>
+    </auro-counter>
+    <auro-counter error="Cannot have more than 2 child passengers">
+      Children
+      <span slot="description">2-17 years</span>
+    </auro-counter>
+  </auro-counter-group>
+  <!-- AURO-GENERATED-CONTENT:END -->
+</div>
+<auro-accordion alignRight>
+  <span slot="trigger">See code</span>
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/dropdown-error-custom.html) -->
+<!-- The below code snippet is automatically added from ./../apiExamples/dropdown-error-custom.html -->
+
+```html
+<auro-counter-group error="Please select the appropriate number of passengers" isDropdown>
+  <div slot="bib.fullscreen.headline">Passengers</div>
+  <div slot="label">Passengers</div>
+  <auro-counter error="Cannot have less than 1 adult passenger">
+    Adults
+    <span slot="description">18 years or older</span>
+  </auro-counter>
+  <auro-counter error="Cannot have more than 2 child passengers">
+    Children
+    <span slot="description">2-17 years</span>
+  </auro-counter>
+</auro-counter-group>
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+</auro-accordion>
+
 ### Group Max/Min
 
 The group counter max or min property sets the value for all counters in the group. If a counter has a max value set, the group max attribute will override it. All increment buttons as a result will be disabled to prevent the group of counters from exceeding the group max.