Skip to content

Commit

Permalink
docs: update real world examples and keyboard increment, update contrib
Browse files Browse the repository at this point in the history
  • Loading branch information
nerdyman committed Oct 29, 2023
1 parent 3f84465 commit 130fd12
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ Checkout out the [Real World Examples page](https://react-compare-slider.vercel.
## Requirements

- React 16.8+
- The [latest two versions](./lib/package.json#L55) of each major browser are officially supported
- The [latest two versions](./lib/package.json#L57) of each major browser are officially supported
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ pnpm run dev
If you already have Storybook running, use the following command:

```sh
pnpm run -w test
pnpm run test
```

If you _don't_ have Storybook running, use the following command:

```sh
pnpm run -w test:ci
pnpm run test:ci
```

## Standards
Expand Down
3 changes: 3 additions & 0 deletions docs/storybook/content/08-keyboard-increment.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ ending in `%`, e.g. `20%` to move the slider 20% of the total slider width in la
or height in portrait mode. A percentage is usually preferable as it adapts relatively to the width or
height of the slider, making it behaving consistently across resolutions.

If you want to effectively disable the keyboard increment, you can set the value to `0`. You can
also set it to `'100%'` to flip between each side immediately.

```jsx
// Increment by 20 pixels.
<ReactCompareSlider
Expand Down
4 changes: 2 additions & 2 deletions docs/storybook/content/99-real-world-examples.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ how it's being used in the wild.
- [Official GOV.UK Coronavirus Dashboard](https://coronavirus.data.gov.uk/details/interactive-map/vaccinations#vaccinations-map-container)
- [Counter-Strike 2 Website](https://www.counter-strike.net/cs2#Maps)
- [Dota 2 Summer Client Update](https://www.dota2.com/summer2023)
- [RoomGPT](https://www.restorephotos.io/)
- [RestorePhotos.io](https://www.roomgpt.io/)
- [RoomGPT](https://github.com/Nutlope/roomGPT)
- [RestorePhotos.io](https://github.com/Nutlope/restorePhotos)

0 comments on commit 130fd12

Please sign in to comment.