@spark-web/field 5.3.1 → 5.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/CLAUDE.md +23 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# @spark-web/field
|
|
2
2
|
|
|
3
|
+
## 5.3.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#789](https://github.com/brighte-labs/spark-web/pull/789)
|
|
8
|
+
[`56d67c3`](https://github.com/brighte-labs/spark-web/commit/56d67c310457b792d663fe4e903111c5f45be90f)
|
|
9
|
+
Thanks [@jacobporci-brighte](https://github.com/jacobporci-brighte)! - Add
|
|
10
|
+
muted hint text pattern to AI context file — documents the description prop
|
|
11
|
+
and its FieldProps equivalent for react-hook-form wrappers.
|
|
12
|
+
|
|
3
13
|
## 5.3.1
|
|
4
14
|
|
|
5
15
|
### Patch Changes
|
package/CLAUDE.md
CHANGED
|
@@ -70,6 +70,29 @@ the label redundant visually, but the label is still required for a11y:
|
|
|
70
70
|
</Field>
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
+
### Muted hint text below label
|
|
74
|
+
|
|
75
|
+
Use `description` to render helper text in muted tone below the label:
|
|
76
|
+
|
|
77
|
+
```tsx
|
|
78
|
+
<Field label="Subject" description="Enter a brief summary of the issue">
|
|
79
|
+
<TextInput placeholder="Type here..." />
|
|
80
|
+
</Field>
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
For react-hook-form wrappers (`TextInputField`, `TextAreaField`) pass it via
|
|
84
|
+
`FieldProps`:
|
|
85
|
+
|
|
86
|
+
```tsx
|
|
87
|
+
<TextInputField
|
|
88
|
+
control={control}
|
|
89
|
+
name="subject"
|
|
90
|
+
label="Subject"
|
|
91
|
+
placeholder="Type here..."
|
|
92
|
+
FieldProps={{ description: 'Enter a brief summary of the issue' }}
|
|
93
|
+
/>
|
|
94
|
+
```
|
|
95
|
+
|
|
73
96
|
## Do NOTs
|
|
74
97
|
|
|
75
98
|
- NEVER use `TextInput` or `Select` without wrapping them in `Field`
|