Skip to content

Commit 29d6692

Browse files
committed
docs: add version info to api-reference and add note to react package
1 parent 47d0bca commit 29d6692

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

docs/pages/api-reference.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,14 +178,18 @@ getSelectionArea(): HTMLElement;
178178

179179
### `getSelectables`
180180

181-
Returns all selectables.
181+
> Available as of [`v3.9.0`](https://github.com/simonwep/viselect/releases/tag/v3.9.0).
182+
183+
Returns all currently selectable elements.
182184

183185
```typescript
184186
getSelectables(): Element[];
185187
```
186188

187189
### `setAreaLocation`
188190

191+
> Available as of [`v3.9.0`](https://github.com/simonwep/viselect/releases/tag/v3.9.0).
192+
189193
Sets the location of the selection area.
190194

191195
```typescript
@@ -196,6 +200,8 @@ setAreaLocation(location: Partial<AreaLocation>): void;
196200

197201
### `getAreaLocation`
198202

203+
> Available as of [`v3.9.0`](https://github.com/simonwep/viselect/releases/tag/v3.9.0).
204+
199205
Returns the current location of the selection area.
200206

201207
```typescript

docs/pages/frameworks/react.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
## Installation
66

7+
> [!WARNING]
8+
> As of [v3.8.0](https://github.com/simonwep/viselect/releases/tag/v3.8.0) Viselect requires React 19 due to breaking changes.
9+
> If you're using an older version of React, use [v3.7.1](https://github.com/simonwep/viselect/releases/tag/v3.7.1).
10+
> Note that older versions are no longer supported, however you can still [roll out your own integration](../custom-integration.md) if you need to - don't worry, it's easy!
11+
712
To use Viselect with React, install its react package with:
813

914
::: code-group

docs/pages/quickstart.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,6 @@ import SelectionArea from '@viselect/vanilla';
108108

109109
const styles = useCssModule();
110110
const container = useTemplateRef('container');
111-
const { matches: mobile } = window.matchMedia('(max-width: 430px)');
112111

113112
onMounted(() => {
114113
const { width } = container.value.getBoundingClientRect();

0 commit comments

Comments
 (0)