@luscii-healthtech/web-ui 59.2.0 → 60.0.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.
@@ -1,7 +1,17 @@
1
1
  import React from "react";
2
2
  type Props = React.ComponentPropsWithRef<"input"> & {
3
3
  /**
4
- * The visual label next to the radio indicator.
4
+ * Content that belongs to this option, rendered underneath it and lined
5
+ * up with the label, such as an extra input that appears when the option
6
+ * is selected. It is rendered outside of the `<label>`, so it can safely
7
+ * contain interactive elements without toggling the radio. Use `label` for
8
+ * the label of the radio itself.
9
+ *
10
+ * The radio's label does not label anything in `children`, so inputs in
11
+ * there need their own accessible name (e.g. `aria-label`). Children are not
12
+ * dimmed when the radio is `disabled`; that is up to the consumer.
13
+ * Best suited for vertical groups, as in a horizontal group the children
14
+ * widen the column of its option.
5
15
  */
6
16
  children?: React.ReactNode;
7
17
  /**
@@ -28,9 +38,9 @@ type Props = React.ComponentPropsWithRef<"input"> & {
28
38
  */
29
39
  id: string;
30
40
  /**
31
- * The visual label next to the radio indicator.
32
- * Alternative to `children` for when it's easier to just pass
33
- * a string as a prop. Will be rendered inside a `<Text>` component.
41
+ * The visual label next to the radio indicator. A string (or number) is
42
+ * rendered inside a `<Text>` component, any other node is rendered as-is,
43
+ * so it can be used for rich labels.
34
44
  */
35
45
  label?: React.ReactNode;
36
46
  /**
@@ -1,7 +1,17 @@
1
1
  import React from "react";
2
2
  type Props = React.ComponentPropsWithRef<"input"> & {
3
3
  /**
4
- * The visual label next to the radio indicator.
4
+ * Content that belongs to this option, rendered underneath it and lined
5
+ * up with the label, such as an extra input that appears when the option
6
+ * is selected. It is rendered outside of the `<label>`, so it can safely
7
+ * contain interactive elements without toggling the radio. Use `label` for
8
+ * the label of the radio itself.
9
+ *
10
+ * The radio's label does not label anything in `children`, so inputs in
11
+ * there need their own accessible name (e.g. `aria-label`). Children are not
12
+ * dimmed when the radio is `disabled`; that is up to the consumer.
13
+ * Best suited for vertical groups, as in a horizontal group the children
14
+ * widen the column of its option.
5
15
  */
6
16
  children?: React.ReactNode;
7
17
  /**
@@ -28,9 +38,9 @@ type Props = React.ComponentPropsWithRef<"input"> & {
28
38
  */
29
39
  id: string;
30
40
  /**
31
- * The visual label next to the radio indicator.
32
- * Alternative to `children` for when it's easier to just pass
33
- * a string as a prop. Will be rendered inside a `<Text>` component.
41
+ * The visual label next to the radio indicator. A string (or number) is
42
+ * rendered inside a `<Text>` component, any other node is rendered as-is,
43
+ * so it can be used for rich labels.
34
44
  */
35
45
  label?: React.ReactNode;
36
46
  /**
@@ -19,6 +19,9 @@ declare const meta: {
19
19
  helperText: {
20
20
  component: string;
21
21
  };
22
+ description: {
23
+ component: string;
24
+ };
22
25
  };
23
26
  };
24
27
  };
@@ -29,6 +32,7 @@ export declare const WithDifferentLabels: Story;
29
32
  export declare const Disabled: Story;
30
33
  export declare const CheckedAndDisabled: Story;
31
34
  export declare const _LabeledRadioGroup: Story;
35
+ export declare const WithNestedContent: Story;
32
36
  export declare const OverviewLabeledRadioCard: Story;
33
37
  export declare const UsingLabelAndSubtitleProps: Story;
34
38
  export declare const UsingChildrenPropForCustomContent: Story;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@luscii-healthtech/web-ui",
3
- "version": "59.2.0",
3
+ "version": "60.0.0",
4
4
  "license": "MIT",
5
5
  "author": {
6
6
  "name": "Joris Janssen"