Skip to content

Commit

Permalink
docs: address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
MarioCastigliano committed Nov 28, 2024
1 parent 357888a commit 5456486
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
9 changes: 9 additions & 0 deletions src/elements/loading-indicator-circle/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ or an ongoing activity which require some time to complete.
<sbb-loading-indicator-circle></sbb-loading-indicator-circle>
```

It can be slotted in other components (e.g. `sbb-button`) in the icon slot.

```html
<sbb-button>
<sbb-loading-indicator-circle slot="icon"></sbb-loading-indicator-circle>
Button
</sbb-button>
```

## Accessibility

If the `sbb-loading-indicator-circle` should be announced by screen-readers, use an element with the correct aria attributes
Expand Down
3 changes: 2 additions & 1 deletion src/elements/loading-indicator/readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
The `sbb-loading-indicator` is a component which can be used to indicate progress status
or an ongoing activity which require some time to complete.
The component completely covers the parent element, preventing interaction with it.

### Style

In `window` mode it's possible to define the `size` of the component, choosing between `s` (default), `l`, `xl`, `xxl`, and `xxxl`.
It's possible to define the `size` of the component, choosing between `s` (default), `l`, `xl`, `xxl`, and `xxxl`.

```html
<sbb-loading-indicator size="l"></sbb-loading-indicator>
Expand Down

0 comments on commit 5456486

Please sign in to comment.