@grapu-design/react-fieldset 0.1.0
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/lib/Fieldset-12s-CPbzkLCF.cjs +121 -0
- package/lib/Fieldset-12s-CW3j613b.js +115 -0
- package/lib/index.cjs +18 -0
- package/lib/index.d.ts +1117 -0
- package/lib/index.js +12 -0
- package/package.json +46 -0
- package/src/Fieldset.namespace.ts +10 -0
- package/src/Fieldset.tsx +61 -0
- package/src/dom.ts +3 -0
- package/src/index.ts +20 -0
- package/src/useFieldset.test.tsx +161 -0
- package/src/useFieldset.ts +73 -0
- package/src/useFieldsetContext.tsx +21 -0
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
var jsxRuntime = require('react/jsx-runtime');
|
|
3
|
+
var reactComposeRefs = require('@radix-ui/react-compose-refs');
|
|
4
|
+
var domUtils = require('@grapu-design/dom-utils');
|
|
5
|
+
var reactPrimitive = require('@grapu-design/react-primitive');
|
|
6
|
+
var react = require('react');
|
|
7
|
+
|
|
8
|
+
const getLabelId = (id)=>`fieldset:${id}:label`;
|
|
9
|
+
const getDescriptionId = (id)=>`fieldset:${id}:description`;
|
|
10
|
+
const getErrorMessageId = (id)=>`fieldset:${id}:error-message`;
|
|
11
|
+
|
|
12
|
+
function useFieldset() {
|
|
13
|
+
const id = react.useId();
|
|
14
|
+
const [isLabelRendered, setIsLabelRendered] = react.useState(false);
|
|
15
|
+
const labelRef = react.useCallback((node)=>{
|
|
16
|
+
setIsLabelRendered(!!node);
|
|
17
|
+
}, []);
|
|
18
|
+
const [isDescriptionRendered, setIsDescriptionRendered] = react.useState(false);
|
|
19
|
+
const descriptionRef = react.useCallback((node)=>{
|
|
20
|
+
setIsDescriptionRendered(!!node);
|
|
21
|
+
}, []);
|
|
22
|
+
const [isErrorMessageRendered, setIsErrorMessageRendered] = react.useState(false);
|
|
23
|
+
const errorMessageRef = react.useCallback((node)=>{
|
|
24
|
+
setIsErrorMessageRendered(!!node);
|
|
25
|
+
}, []);
|
|
26
|
+
const ariaDescribedBy = [
|
|
27
|
+
isDescriptionRendered ? getDescriptionId(id) : false,
|
|
28
|
+
isErrorMessageRendered ? getErrorMessageId(id) : false
|
|
29
|
+
].filter(Boolean).join(" ") || undefined;
|
|
30
|
+
return {
|
|
31
|
+
id,
|
|
32
|
+
refs: {
|
|
33
|
+
label: labelRef,
|
|
34
|
+
description: descriptionRef,
|
|
35
|
+
errorMessage: errorMessageRef
|
|
36
|
+
},
|
|
37
|
+
renderedElements: {
|
|
38
|
+
label: isLabelRendered,
|
|
39
|
+
description: isDescriptionRendered,
|
|
40
|
+
errorMessage: isErrorMessageRendered
|
|
41
|
+
},
|
|
42
|
+
rootProps: domUtils.elementProps({
|
|
43
|
+
// see: https://w3c.github.io/aria/#group
|
|
44
|
+
role: "group",
|
|
45
|
+
// note: aria-disabled is supported but useFieldset doesn't know about the disabled state of its children
|
|
46
|
+
// note: aria-required and aria-invalid should not be set here
|
|
47
|
+
...isLabelRendered && {
|
|
48
|
+
"aria-labelledby": getLabelId(id)
|
|
49
|
+
},
|
|
50
|
+
"aria-describedby": ariaDescribedBy
|
|
51
|
+
}),
|
|
52
|
+
labelProps: domUtils.elementProps({
|
|
53
|
+
id: getLabelId(id)
|
|
54
|
+
}),
|
|
55
|
+
descriptionProps: domUtils.elementProps({
|
|
56
|
+
id: getDescriptionId(id)
|
|
57
|
+
}),
|
|
58
|
+
errorMessageProps: domUtils.elementProps({
|
|
59
|
+
id: getErrorMessageId(id),
|
|
60
|
+
"aria-live": "polite"
|
|
61
|
+
})
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
const FieldsetContext = /*#__PURE__*/ react.createContext(null);
|
|
66
|
+
const FieldsetProvider = FieldsetContext.Provider;
|
|
67
|
+
function useFieldsetContext({ strict = true } = {}) {
|
|
68
|
+
const context = react.useContext(FieldsetContext);
|
|
69
|
+
if (!context && strict) {
|
|
70
|
+
throw new Error("useFieldsetContext must be used within a Fieldset");
|
|
71
|
+
}
|
|
72
|
+
return context;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
const FieldsetRoot = /*#__PURE__*/ react.forwardRef((props, ref)=>{
|
|
76
|
+
const api = useFieldset();
|
|
77
|
+
const mergedProps = domUtils.mergeProps(api.rootProps, props);
|
|
78
|
+
return /*#__PURE__*/ jsxRuntime.jsx(FieldsetProvider, {
|
|
79
|
+
value: api,
|
|
80
|
+
children: /*#__PURE__*/ jsxRuntime.jsx(reactPrimitive.Primitive.div, {
|
|
81
|
+
ref: ref,
|
|
82
|
+
...mergedProps
|
|
83
|
+
})
|
|
84
|
+
});
|
|
85
|
+
});
|
|
86
|
+
FieldsetRoot.displayName = "FieldsetRoot";
|
|
87
|
+
const FieldsetLabel = /*#__PURE__*/ react.forwardRef((props, ref)=>{
|
|
88
|
+
const { refs, labelProps } = useFieldsetContext();
|
|
89
|
+
const mergedProps = domUtils.mergeProps(labelProps, props);
|
|
90
|
+
return /*#__PURE__*/ jsxRuntime.jsx(reactPrimitive.Primitive.div, {
|
|
91
|
+
ref: reactComposeRefs.composeRefs(refs.label, ref),
|
|
92
|
+
...mergedProps
|
|
93
|
+
});
|
|
94
|
+
});
|
|
95
|
+
FieldsetLabel.displayName = "FieldsetLabel";
|
|
96
|
+
const FieldsetDescription = /*#__PURE__*/ react.forwardRef((props, ref)=>{
|
|
97
|
+
const { refs, descriptionProps } = useFieldsetContext();
|
|
98
|
+
const mergedProps = domUtils.mergeProps(descriptionProps, props);
|
|
99
|
+
return /*#__PURE__*/ jsxRuntime.jsx(reactPrimitive.Primitive.span, {
|
|
100
|
+
ref: reactComposeRefs.composeRefs(refs.description, ref),
|
|
101
|
+
...mergedProps
|
|
102
|
+
});
|
|
103
|
+
});
|
|
104
|
+
FieldsetDescription.displayName = "FieldsetDescription";
|
|
105
|
+
const FieldsetErrorMessage = /*#__PURE__*/ react.forwardRef((props, ref)=>{
|
|
106
|
+
const { refs, errorMessageProps } = useFieldsetContext();
|
|
107
|
+
const mergedProps = domUtils.mergeProps(errorMessageProps, props);
|
|
108
|
+
return /*#__PURE__*/ jsxRuntime.jsx(reactPrimitive.Primitive.div, {
|
|
109
|
+
ref: reactComposeRefs.composeRefs(refs.errorMessage, ref),
|
|
110
|
+
...mergedProps
|
|
111
|
+
});
|
|
112
|
+
});
|
|
113
|
+
FieldsetErrorMessage.displayName = "FieldsetErrorMessage";
|
|
114
|
+
|
|
115
|
+
exports.FieldsetDescription = FieldsetDescription;
|
|
116
|
+
exports.FieldsetErrorMessage = FieldsetErrorMessage;
|
|
117
|
+
exports.FieldsetLabel = FieldsetLabel;
|
|
118
|
+
exports.FieldsetProvider = FieldsetProvider;
|
|
119
|
+
exports.FieldsetRoot = FieldsetRoot;
|
|
120
|
+
exports.useFieldset = useFieldset;
|
|
121
|
+
exports.useFieldsetContext = useFieldsetContext;
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
import { jsx } from 'react/jsx-runtime';
|
|
3
|
+
import { composeRefs } from '@radix-ui/react-compose-refs';
|
|
4
|
+
import { elementProps, mergeProps } from '@grapu-design/dom-utils';
|
|
5
|
+
import { Primitive } from '@grapu-design/react-primitive';
|
|
6
|
+
import { useId, useState, useCallback, createContext, useContext, forwardRef } from 'react';
|
|
7
|
+
|
|
8
|
+
const getLabelId = (id)=>`fieldset:${id}:label`;
|
|
9
|
+
const getDescriptionId = (id)=>`fieldset:${id}:description`;
|
|
10
|
+
const getErrorMessageId = (id)=>`fieldset:${id}:error-message`;
|
|
11
|
+
|
|
12
|
+
function useFieldset() {
|
|
13
|
+
const id = useId();
|
|
14
|
+
const [isLabelRendered, setIsLabelRendered] = useState(false);
|
|
15
|
+
const labelRef = useCallback((node)=>{
|
|
16
|
+
setIsLabelRendered(!!node);
|
|
17
|
+
}, []);
|
|
18
|
+
const [isDescriptionRendered, setIsDescriptionRendered] = useState(false);
|
|
19
|
+
const descriptionRef = useCallback((node)=>{
|
|
20
|
+
setIsDescriptionRendered(!!node);
|
|
21
|
+
}, []);
|
|
22
|
+
const [isErrorMessageRendered, setIsErrorMessageRendered] = useState(false);
|
|
23
|
+
const errorMessageRef = useCallback((node)=>{
|
|
24
|
+
setIsErrorMessageRendered(!!node);
|
|
25
|
+
}, []);
|
|
26
|
+
const ariaDescribedBy = [
|
|
27
|
+
isDescriptionRendered ? getDescriptionId(id) : false,
|
|
28
|
+
isErrorMessageRendered ? getErrorMessageId(id) : false
|
|
29
|
+
].filter(Boolean).join(" ") || undefined;
|
|
30
|
+
return {
|
|
31
|
+
id,
|
|
32
|
+
refs: {
|
|
33
|
+
label: labelRef,
|
|
34
|
+
description: descriptionRef,
|
|
35
|
+
errorMessage: errorMessageRef
|
|
36
|
+
},
|
|
37
|
+
renderedElements: {
|
|
38
|
+
label: isLabelRendered,
|
|
39
|
+
description: isDescriptionRendered,
|
|
40
|
+
errorMessage: isErrorMessageRendered
|
|
41
|
+
},
|
|
42
|
+
rootProps: elementProps({
|
|
43
|
+
// see: https://w3c.github.io/aria/#group
|
|
44
|
+
role: "group",
|
|
45
|
+
// note: aria-disabled is supported but useFieldset doesn't know about the disabled state of its children
|
|
46
|
+
// note: aria-required and aria-invalid should not be set here
|
|
47
|
+
...isLabelRendered && {
|
|
48
|
+
"aria-labelledby": getLabelId(id)
|
|
49
|
+
},
|
|
50
|
+
"aria-describedby": ariaDescribedBy
|
|
51
|
+
}),
|
|
52
|
+
labelProps: elementProps({
|
|
53
|
+
id: getLabelId(id)
|
|
54
|
+
}),
|
|
55
|
+
descriptionProps: elementProps({
|
|
56
|
+
id: getDescriptionId(id)
|
|
57
|
+
}),
|
|
58
|
+
errorMessageProps: elementProps({
|
|
59
|
+
id: getErrorMessageId(id),
|
|
60
|
+
"aria-live": "polite"
|
|
61
|
+
})
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
const FieldsetContext = /*#__PURE__*/ createContext(null);
|
|
66
|
+
const FieldsetProvider = FieldsetContext.Provider;
|
|
67
|
+
function useFieldsetContext({ strict = true } = {}) {
|
|
68
|
+
const context = useContext(FieldsetContext);
|
|
69
|
+
if (!context && strict) {
|
|
70
|
+
throw new Error("useFieldsetContext must be used within a Fieldset");
|
|
71
|
+
}
|
|
72
|
+
return context;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
const FieldsetRoot = /*#__PURE__*/ forwardRef((props, ref)=>{
|
|
76
|
+
const api = useFieldset();
|
|
77
|
+
const mergedProps = mergeProps(api.rootProps, props);
|
|
78
|
+
return /*#__PURE__*/ jsx(FieldsetProvider, {
|
|
79
|
+
value: api,
|
|
80
|
+
children: /*#__PURE__*/ jsx(Primitive.div, {
|
|
81
|
+
ref: ref,
|
|
82
|
+
...mergedProps
|
|
83
|
+
})
|
|
84
|
+
});
|
|
85
|
+
});
|
|
86
|
+
FieldsetRoot.displayName = "FieldsetRoot";
|
|
87
|
+
const FieldsetLabel = /*#__PURE__*/ forwardRef((props, ref)=>{
|
|
88
|
+
const { refs, labelProps } = useFieldsetContext();
|
|
89
|
+
const mergedProps = mergeProps(labelProps, props);
|
|
90
|
+
return /*#__PURE__*/ jsx(Primitive.div, {
|
|
91
|
+
ref: composeRefs(refs.label, ref),
|
|
92
|
+
...mergedProps
|
|
93
|
+
});
|
|
94
|
+
});
|
|
95
|
+
FieldsetLabel.displayName = "FieldsetLabel";
|
|
96
|
+
const FieldsetDescription = /*#__PURE__*/ forwardRef((props, ref)=>{
|
|
97
|
+
const { refs, descriptionProps } = useFieldsetContext();
|
|
98
|
+
const mergedProps = mergeProps(descriptionProps, props);
|
|
99
|
+
return /*#__PURE__*/ jsx(Primitive.span, {
|
|
100
|
+
ref: composeRefs(refs.description, ref),
|
|
101
|
+
...mergedProps
|
|
102
|
+
});
|
|
103
|
+
});
|
|
104
|
+
FieldsetDescription.displayName = "FieldsetDescription";
|
|
105
|
+
const FieldsetErrorMessage = /*#__PURE__*/ forwardRef((props, ref)=>{
|
|
106
|
+
const { refs, errorMessageProps } = useFieldsetContext();
|
|
107
|
+
const mergedProps = mergeProps(errorMessageProps, props);
|
|
108
|
+
return /*#__PURE__*/ jsx(Primitive.div, {
|
|
109
|
+
ref: composeRefs(refs.errorMessage, ref),
|
|
110
|
+
...mergedProps
|
|
111
|
+
});
|
|
112
|
+
});
|
|
113
|
+
FieldsetErrorMessage.displayName = "FieldsetErrorMessage";
|
|
114
|
+
|
|
115
|
+
export { FieldsetDescription as F, FieldsetErrorMessage as a, FieldsetLabel as b, FieldsetRoot as c, FieldsetProvider as d, useFieldsetContext as e, useFieldset as u };
|
package/lib/index.cjs
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
var Fieldset12s = require('./Fieldset-12s-CPbzkLCF.cjs');
|
|
2
|
+
|
|
3
|
+
var Fieldset_namespace = {
|
|
4
|
+
__proto__: null,
|
|
5
|
+
Description: Fieldset12s.FieldsetDescription,
|
|
6
|
+
ErrorMessage: Fieldset12s.FieldsetErrorMessage,
|
|
7
|
+
Label: Fieldset12s.FieldsetLabel,
|
|
8
|
+
Root: Fieldset12s.FieldsetRoot
|
|
9
|
+
};
|
|
10
|
+
|
|
11
|
+
exports.FieldsetDescription = Fieldset12s.FieldsetDescription;
|
|
12
|
+
exports.FieldsetErrorMessage = Fieldset12s.FieldsetErrorMessage;
|
|
13
|
+
exports.FieldsetLabel = Fieldset12s.FieldsetLabel;
|
|
14
|
+
exports.FieldsetProvider = Fieldset12s.FieldsetProvider;
|
|
15
|
+
exports.FieldsetRoot = Fieldset12s.FieldsetRoot;
|
|
16
|
+
exports.useFieldset = Fieldset12s.useFieldset;
|
|
17
|
+
exports.useFieldsetContext = Fieldset12s.useFieldsetContext;
|
|
18
|
+
exports.Fieldset = Fieldset_namespace;
|