Skip to content

Commit 5323983

Browse files
author
Fabien MARIE-LOUISE
committed
docs(radio): update readme
1 parent 284a9b8 commit 5323983

File tree

26 files changed

+245
-95
lines changed

26 files changed

+245
-95
lines changed

.changeset/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"commit": false,
55
"fixed": [],
66
"linked": [],
7-
"access": "restricted",
7+
"access": "public",
88
"baseBranch": "main",
99
"updateInternalDependencies": "patch",
1010
"ignore": []

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
operating-system: [ubuntu-latest]
1313

1414
steps:
15-
- name: Check out code
15+
- name: Checkout repo
1616
uses: actions/checkout@v2
1717
with:
1818
fetch-depth: 2

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,15 @@
1313
],
1414
"scripts": {
1515
"build": "turbo run build",
16+
"changeset": "changeset",
17+
"clean": "turbo run clean && rm -rf node_modules",
1618
"commit": "git-cz",
1719
"format": "prettier . --write --ignore-path .gitignore && git update-index --again",
1820
"lint": "eslint . --ext .ts,.tsx --ignore-path .gitignore",
1921
"prepare": "husky install",
20-
"test": "turbo run test"
22+
"release": "turbo run build && changeset publish",
23+
"test": "turbo run test",
24+
"version-packages": "changeset version"
2125
},
2226
"lint-staged": {
2327
"*.{md,json}": [

packages/checkbox/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@ Checkboxes can be built with the `<input>` HTML element, but this can be difficu
3939
### How to use it
4040

4141
```tsx
42-
import { createCheckbox } from "@solid-aria/checkbox";
42+
import { AriaCheckboxProps, createCheckbox } from "@solid-aria/checkbox";
4343
import { createToggleState } from "@solid-aria/toggle";
44-
import { AriaCheckboxProps } from "@solid-aria/types";
4544

4645
function Checkbox(props: AriaCheckboxProps) {
4746
let ref: HTMLInputElement | undefined;
@@ -74,10 +73,9 @@ To build a custom styled checkbox, you can make the native input element visuall
7473
For keyboard accessibility, a focus ring is important to indicate which element has keyboard focus. This is implemented with the `createFocusRing` primitive. When `isFocusVisible` is true, an extra SVG element is rendered to indicate focus. The focus ring is only visible when the user is interacting with a keyboard, not with a mouse or touch.
7574

7675
```tsx
76+
import { AriaCheckboxProps, createCheckbox } from "@solid-aria/checkbox";
7777
import { createFocusRing } from "@solid-aria/focus";
78-
import { createCheckbox } from "@solid-aria/checkbox";
7978
import { createToggleState } from "@solid-aria/toggle";
80-
import { AriaCheckboxProps } from "@solid-aria/types";
8179
import { createVisuallyHidden } from "@solid-aria/visually-hidden";
8280

8381
import { Show } from "solid-js/web";
@@ -157,12 +155,13 @@ This example uses native input elements for the checkboxes, and SolidJS context
157155

158156
```tsx
159157
import {
158+
AriaCheckboxGroupItemProps,
159+
AriaCheckboxGroupProps,
160160
CheckboxGroupState,
161161
createCheckboxGroup,
162162
createCheckboxGroupItem,
163163
createCheckboxGroupState
164164
} from "@solid-aria/checkbox";
165-
import { AriaCheckboxGroupItemProps, AriaCheckboxGroupProps } from "@solid-aria/types";
166165

167166
import { createContext, useContext } from "solid-js";
168167

packages/checkbox/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
],
3333
"scripts": {
3434
"build": "tsup",
35+
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
3536
"dev": "vite serve dev --host",
3637
"test": "jest --passWithNoTests",
3738
"test:watch": "jest --watch --passWithNoTests",
@@ -47,6 +48,9 @@
4748
"@solid-primitives/utils": "^1.3.0",
4849
"solid-js": "^1.3.15"
4950
},
51+
"publishConfig": {
52+
"access": "public"
53+
},
5054
"primitive": {
5155
"name": "checkbox",
5256
"stage": 0,

packages/focus/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
],
3333
"scripts": {
3434
"build": "tsup",
35+
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
3536
"dev": "vite serve dev --host",
3637
"test": "jest --passWithNoTests",
3738
"test:watch": "jest --watch --passWithNoTests",
@@ -46,6 +47,9 @@
4647
"@solid-primitives/utils": "^1.3.0",
4748
"solid-js": "^1.3.15"
4849
},
50+
"publishConfig": {
51+
"access": "public"
52+
},
4953
"primitive": {
5054
"name": "focus",
5155
"stage": 0,

packages/i18n/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
],
3333
"scripts": {
3434
"build": "tsup",
35+
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
3536
"dev": "vite serve dev --host",
3637
"test": "jest --passWithNoTests",
3738
"test:watch": "jest --watch --passWithNoTests",
@@ -45,6 +46,9 @@
4546
"@solid-primitives/utils": "^1.3.0",
4647
"solid-js": "^1.3.15"
4748
},
49+
"publishConfig": {
50+
"access": "public"
51+
},
4852
"primitive": {
4953
"name": "i18n",
5054
"stage": 0,

packages/interactions/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
],
3333
"scripts": {
3434
"build": "tsup",
35+
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
3536
"dev": "vite serve dev --host",
3637
"test": "jest --passWithNoTests",
3738
"test:watch": "jest --watch --passWithNoTests",
@@ -45,6 +46,9 @@
4546
"@solid-primitives/utils": "^1.3.0",
4647
"solid-js": "^1.3.15"
4748
},
49+
"publishConfig": {
50+
"access": "public"
51+
},
4852
"primitive": {
4953
"name": "interactions",
5054
"stage": 0,

packages/label/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ Provides the accessibility implementation for labels and their associated elemen
2929
### How to use it
3030

3131
```tsx
32-
import { createLabel } from "@solid-aria/label";
33-
import { AriaLabelProps } from "@solid-aria/types";
32+
import { AriaLabelProps, createLabel } from "@solid-aria/label";
3433

3534
interface ColorFieldProps extends AriaLabelProps {
3635
// your component specific props

packages/label/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
],
3333
"scripts": {
3434
"build": "tsup",
35+
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
3536
"dev": "vite serve dev --host",
3637
"test": "jest --passWithNoTests",
3738
"test:watch": "jest --watch --passWithNoTests",
@@ -45,6 +46,9 @@
4546
"@solid-primitives/utils": "^1.3.0",
4647
"solid-js": "^1.3.15"
4748
},
49+
"publishConfig": {
50+
"access": "public"
51+
},
4852
"primitive": {
4953
"name": "label",
5054
"stage": 0,

0 commit comments

Comments
 (0)