Skip to content

Commit

Permalink
docs(nocheckmark): add missing examples on docsite #88
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanjones243 committed Sep 13, 2022
1 parent 1148ac1 commit 2da2ac2
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 0 deletions.
10 changes: 10 additions & 0 deletions apiExamples/noCheckmark.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<auro-select nocheckmark>
<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>
1 change: 1 addition & 0 deletions demo/apiExamples.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ The auro-select element is a wrapper for auro-dropdown and auro-menu to create a
|------------------|------------------|-----------|------------------------|--------------------------------------------------|
| [disabled](#disabled) | `disabled` | `Boolean` | | When attribute is present element shows disabled state. |
| [error](#error) | `error` | `Boolean` | | When attribute is present element shows error state. |
| [nocheckmark](#nocheckmark) | `nocheckmark` | `Boolean` | | When true, checkmark on selected option will no longer be present. |
| [optionSelected](#optionSelected) | `optionSelected` | `Object` | "undefined" | Specifies the current selected menuOption. |
| [placeholder](#placeholder) | `placeholder` | `String` | "Please select option" | Define placeholder text to display before a value is manually selected. |
| [value](#value) | `value` | `String` | | Value selected for the component. |
Expand Down
37 changes: 37 additions & 0 deletions demo/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,43 @@ A baseline `<auro-select>` using `<auro-menu>` and `<auro-menuoption>` elements.
<!-- AURO-GENERATED-CONTENT:END -->
</auro-accordion>

### Example with no checkmark

<div class="exampleWrapper">
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/noCheckmark.html) -->
<!-- The below content is automatically added from ./../../apiExamples/noCheckmark.html -->
<auro-select nocheckmark>
<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 lowProfile justifyRight>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/noCheckmark.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/noCheckmark.html -->

```html
<auro-select nocheckmark>
<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>

## Label and help text slots

The following example illustrates the use of the `label` and `helptext` slots for additional placement of content around the select menu.
Expand Down
1 change: 1 addition & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The auro-select element is a wrapper for auro-dropdown and auro-menu to create a
|------------------|------------------|-----------|------------------------|--------------------------------------------------|
| `disabled` | `disabled` | `Boolean` | | When attribute is present element shows disabled state. |
| `error` | `error` | `Boolean` | | When attribute is present element shows error state. |
| `nocheckmark` | `nocheckmark` | `Boolean` | | When true, checkmark on selected option will no longer be present. |
| `optionSelected` | `optionSelected` | `Object` | "undefined" | Specifies the current selected menuOption. |
| `placeholder` | `placeholder` | `String` | "Please select option" | Define placeholder text to display before a value is manually selected. |
| `value` | `value` | `String` | | Value selected for the component. |
Expand Down
16 changes: 16 additions & 0 deletions docs/partials/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ A baseline `<auro-select>` using `<auro-menu>` and `<auro-menuoption>` elements.
<!-- AURO-GENERATED-CONTENT:END -->
</div>


<auro-accordion lowProfile justifyRight>
<span slot="trigger">See code</span>

Expand All @@ -58,6 +59,21 @@ A baseline `<auro-select>` using `<auro-menu>` and `<auro-menuoption>` elements.

</auro-accordion>

### Example with no checkmark

<div class="exampleWrapper">
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/noCheckmark.html) -->
<!-- AURO-GENERATED-CONTENT:END -->
</div>

<auro-accordion lowProfile justifyRight>
<span slot="trigger">See code</span>

<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/noCheckmark.html) -->
<!-- AURO-GENERATED-CONTENT:END -->

</auro-accordion>

## Label and help text slots

The following example illustrates the use of the `label` and `helptext` slots for additional placement of content around the select menu.
Expand Down

0 comments on commit 2da2ac2

Please sign in to comment.