Skip to content

Commit

Permalink
Docs(web): Use dash instead of underscore for id and name attribu…
Browse files Browse the repository at this point in the history
…te values in `Modal` docs
  • Loading branch information
adamkudrna committed Jan 4, 2024
1 parent a907e23 commit cbe878b
Show file tree
Hide file tree
Showing 2 changed files with 112 additions and 112 deletions.
42 changes: 21 additions & 21 deletions packages/web/src/scss/components/Modal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Modal establishes the top layer with a backdrop. Under the hood it uses the [`<d
provides several accessibility advantages.

```html
<dialog id="example_1" class="Modal" aria-labelledby="example_1_title">
<dialog id="modal-example" class="Modal" aria-labelledby="modal-example-title">
<!-- ModalDialog -->
</dialog>
```
Expand All @@ -34,9 +34,9 @@ This is useful for Modals with dynamic content, e.g. a list of items that can be

```html
<dialog
id="example_1"
id="modal-example"
class="Modal"
aria-labelledby="example_1_title"
aria-labelledby="modal-example-title"
style="--modal-preferred-height-mobile: 400px; --modal-preferred-height-tablet: 500px;"
>
<!-- ModalDialog -->
Expand All @@ -55,7 +55,7 @@ The default maximum height of Modal is:
You can use the custom property `--modal-max-height-tablet` to override the max height on tablet screens and up:

```html
<dialog id="example_1" class="Modal" aria-labelledby="example_1_title" style="--modal-max-height-tablet: 700px">
<dialog id="modal-example" class="Modal" aria-labelledby="modal-example-title" style="--modal-max-height-tablet: 700px">
<!-- ModalDialog -->
</dialog>
```
Expand Down Expand Up @@ -107,13 +107,13 @@ and allows users to easily close it.

```html
<div class="ModalHeader">
<h2 id="example_1_title" class="ModalHeader__title">Modal Title</h2>
<h2 id="modal-example-title" class="ModalHeader__title">Modal Title</h2>
<button
type="button"
class="Button Button--tertiary Button--square Button--medium"
data-spirit-dismiss="modal"
data-spirit-target="#example_1"
aria-controls="example_1"
data-spirit-target="#modal-example"
aria-controls="modal-example"
aria-expanded="false"
>
<svg width="24" height="24" aria-hidden="true">
Expand All @@ -130,7 +130,7 @@ Even in cases you don't need the title to be visible you should provide an acces
the `aria-label` attribute on the `<dialog>` element:

```html
<dialog id="example_1" class="Modal" aria-label="Accessible Modal Title">
<dialog id="modal-example" class="Modal" aria-label="Accessible Modal Title">
<!---->
</dialog>
```
Expand Down Expand Up @@ -168,15 +168,15 @@ to compensate for the lost spacing by applying utility spacing classes to the Mo
type="button"
class="Button Button--primary Button--medium"
data-spirit-dismiss="modal"
data-spirit-target="#example_1"
data-spirit-target="#modal-example"
>
Primary action
</button>
<button
type="button"
class="Button Button--secondary Button--medium"
data-spirit-dismiss="modal"
data-spirit-target="#example_1"
data-spirit-target="#modal-example"
>
Secondary action
</button>
Expand Down Expand Up @@ -215,8 +215,8 @@ Use our JavaScript plugin to open your Modal, e.g.:
type="button"
class="Button Button--primary Button--medium"
data-spirit-toggle="modal"
data-spirit-target="#example_1"
aria-controls="example_1"
data-spirit-target="#modal-example"
aria-controls="modal-example"
aria-expanded="false"
>
Open Modal
Expand All @@ -229,7 +229,7 @@ Disable modal close when clicking on the backdrop.
You can still close modal with close buttons or ESC key.

```html
<dialog id="example_1" class="Modal" data-spirit-backdrop-close-disabled="true">
<dialog id="modal-example" class="Modal" data-spirit-backdrop-close-disabled="true">
<!---->
</dialog>
```
Expand Down Expand Up @@ -267,27 +267,27 @@ When you put it all together:
type="button"
class="Button Button--primary Button--medium"
data-spirit-toggle="modal"
data-spirit-target="#example_1"
aria-controls="example_1"
data-spirit-target="#modal-example"
aria-controls="modal-example"
aria-expanded="false"
>
Open Modal
</button>
<!-- Modal Trigger: end -->

<!-- Modal: start -->
<dialog id="example_1" class="Modal" aria-labelledby="example_1_title">
<dialog id="modal-example" class="Modal" aria-labelledby="modal-example-title">
<!-- ModalDialog: start -->
<article class="ModalDialog">
<!-- ModalHeader: start -->
<div class="ModalHeader">
<h2 id="example_1_title" class="ModalHeader__title">Modal Title</h2>
<h2 id="modal-example-title" class="ModalHeader__title">Modal Title</h2>
<button
type="button"
class="Button Button--tertiary Button--square Button--medium"
data-spirit-dismiss="modal"
data-spirit-target="#example_1"
aria-controls="example_1"
data-spirit-target="#modal-example"
aria-controls="modal-example"
aria-expanded="false"
>
<svg width="24" height="24" aria-hidden="true">
Expand Down Expand Up @@ -318,15 +318,15 @@ When you put it all together:
type="button"
class="Button Button--primary Button--medium"
data-spirit-dismiss="modal"
data-spirit-target="#example_1"
data-spirit-target="#modal-example"
>
Primary action
</button>
<button
type="button"
class="Button Button--secondary Button--medium"
data-spirit-dismiss="modal"
data-spirit-target="#example_1"
data-spirit-target="#modal-example"
>
Secondary action
</button>
Expand Down
Loading

0 comments on commit cbe878b

Please sign in to comment.