Skip to content

Commit

Permalink
docs: 📝 update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@navin-moorthy
navin-moorthy committed Aug 13, 2021
1 parent 149a796 commit 749ac80
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 43 deletions.
6 changes: 3 additions & 3 deletions docs/calendar.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@ Also we can customize and style the ranges with CSS attribute selectors

| Name | Type | Description |
| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`goto`** | <code title="&#34;nextMonth&#34; \| &#34;previousMonth&#34; \| &#34;nextYear&#34; \| &#34;previousYear&#34;">&#34;nextMonth&#34; \| &#34;previousMonth&#34; \| &#34;nextYear&#34; \| &#34;p...</code> | |
| **`disabled`** | <code>boolean \| undefined</code> | Same as the HTML attribute. |
| **`focusable`** | <code>boolean \| undefined</code> | When an element is `disabled`, it may still be `focusable`. It workssimilarly to `readOnly` on form elements. In this case, only`aria-disabled` will be set. |
| **`goto`** | <code title="&#34;nextMonth&#34; \| &#34;previousMonth&#34; \| &#34;nextYear&#34; \| &#34;previousYear&#34;">&#34;nextMonth&#34; \| &#34;previousMonth&#34; \| &#34;nextYear&#34; \| &#34;p...</code> | |

<details><summary>4 state props</summary>
> These props are returned by the state hook. You can spread them into this component (`{...state}`) or pass them separately. You can also provide these props from your own state logic.
Expand Down Expand Up @@ -240,15 +240,16 @@ Also we can customize and style the ranges with CSS attribute selectors

| Name | Type | Description |
| :-------------- | :-------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`date`** | <code>Date</code> | |
| **`disabled`** | <code>boolean \| undefined</code> | Same as the HTML attribute. |
| **`focusable`** | <code>boolean \| undefined</code> | When an element is `disabled`, it may still be `focusable`. It workssimilarly to `readOnly` on form elements. In this case, only`aria-disabled` will be set. |
| **`date`** | <code>Date</code> | |

<details><summary>11 state props</summary>
> These props are returned by the state hook. You can spread them into this component (`{...state}`) or pass them separately. You can also provide these props from your own state logic.
| Name | Type | Description |
| :-------------------- | :------------------------------------------------------------- | :---------------------------------------------- |
| **`anchorDate`** | <code>Date \| null</code> | |
| **`dateValue`** | <code>Date</code> | Selected Date value |
| **`isDisabled`** | <code>boolean</code> | `true` if the calendar is disabled |
| **`isRangeCalendar`** | <code>boolean</code> | `true` if the calendar is used as RangeCalendar |
Expand All @@ -259,7 +260,6 @@ Also we can customize and style the ranges with CSS attribute selectors
| **`minDate`** | <code>Date \| undefined</code> | Minimum allowed Date value |
| **`maxDate`** | <code>Date \| undefined</code> | Maximum allowed Date value |
| **`isFocused`** | <code>boolean</code> | `true` if the calendar is focused |
| **`anchorDate`** | <code>Date \| null</code> | |

</details>

Expand Down
8 changes: 4 additions & 4 deletions docs/slider.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,13 @@ export const App = args => {
export default App;
```

[![Edit CodeSandbox](https://img.shields.io/badge/Single%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/1oixd)
[![Edit CodeSandbox](https://img.shields.io/badge/Single%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/s7k9t)

[![Edit CodeSandbox](https://img.shields.io/badge/Single%20Origin%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/mkdgw)
[![Edit CodeSandbox](https://img.shields.io/badge/Single%20Origin%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/mbvvy)

[![Edit CodeSandbox](https://img.shields.io/badge/Single%20Reversed%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/f6hfw)
[![Edit CodeSandbox](https://img.shields.io/badge/Single%20Reversed%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/ldgwg)

[![Edit CodeSandbox](https://img.shields.io/badge/Single%20Vertical%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/usf1j)
[![Edit CodeSandbox](https://img.shields.io/badge/Single%20Vertical%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/q2lvt)

[![Edit CodeSandbox](https://img.shields.io/badge/Range%20Slider-Open%20On%20CodeSandbox-%230971f1?style=for-the-badge&logo=codesandbox&labelColor=151515)](https://codesandbox.io/s/94sn8)

Expand Down
Loading

0 comments on commit 749ac80

Please sign in to comment.