@instructure/ui-radio-input 9.8.1 → 9.9.0

package/types/RadioInputGroup/index.d.ts

@@ -1,6 +1,8 @@
+/** @jsx jsx */
 import React, { Component } from 'react';
 import { RadioInput } from '../RadioInput';
 import type { RadioInputProps } from '../RadioInput/props';
+import { jsx } from '@instructure/emotion';
 import type { RadioInputGroupProps, RadioInputGroupState } from './props';
 type RadioInputChild = React.ComponentElement<RadioInputProps, RadioInput>;
 /**
@@ -23,6 +25,7 @@ declare class RadioInputGroup extends Component<RadioInputGroupProps, RadioInput
         size?: "small" | "medium" | "large";
         layout?: "stacked" | "columns" | "inline";
         children?: React.ReactNode;
+        isRequired?: boolean;
     })[];
     static propTypes: import("@instructure/shared-types").PropValidators<keyof {
         name: string;
@@ -37,6 +40,7 @@ declare class RadioInputGroup extends Component<RadioInputGroupProps, RadioInput
         size?: "small" | "medium" | "large";
         layout?: "stacked" | "columns" | "inline";
         children?: React.ReactNode;
+        isRequired?: boolean;
     }>;
     static defaultProps: {
         disabled: boolean;
@@ -50,10 +54,11 @@ declare class RadioInputGroup extends Component<RadioInputGroupProps, RadioInput
     handleRef: (el: Element | null) => void;
     constructor(props: RadioInputGroupProps);
     get hasMessages(): boolean;
+    get invalid(): boolean;
     handleChange: RadioInputProps['onChange'];
     get value(): string | number | undefined;
     renderChildren(): (string | number | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | RadioInputChild)[] | null | undefined;
-    render(): React.JSX.Element;
+    render(): jsx.JSX.Element;
 }
 export default RadioInputGroup;
 export { RadioInputGroup };

package/types/RadioInputGroup/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/RadioInputGroup/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAY,SAAS,EAAE,MAAM,OAAO,CAAA;AAYlD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAE1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAGzE,KAAK,eAAe,GAAG,KAAK,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,CAAA;AAE1E;;;;GAIG;AACH,cAEM,eAAgB,SAAQ,SAAS,CACrC,oBAAoB,EACpB,oBAAoB,CACrB;IACC,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,YAAY;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;MAMlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IAEpC,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;gBAEW,KAAK,EAAE,oBAAoB;IAYvC,IAAI,WAAW,YAEd;IAED,YAAY,EAAE,eAAe,CAAC,UAAU,CAAC,CAexC;IAED,IAAI,KAAK,gCAIR;IAED,cAAc;IA+Bd,MAAM;CAuBP;AAED,eAAe,eAAe,CAAA;AAC9B,OAAO,EAAE,eAAe,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/RadioInputGroup/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAY,SAAS,EAAE,MAAM,OAAO,CAAA;AAalD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAE1D,OAAO,EAAE,GAAG,EAAa,MAAM,sBAAsB,CAAA;AAKrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAGzE,KAAK,eAAe,GAAG,KAAK,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,CAAA;AAE1E;;;;GAIG;AACH,cAGM,eAAgB,SAAQ,SAAS,CACrC,oBAAoB,EACpB,oBAAoB,CACrB;IACC,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,YAAY;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;MAMlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IAEpC,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;gBAEW,KAAK,EAAE,oBAAoB;IAYvC,IAAI,WAAW,YAEd;IAED,IAAI,OAAO,YAIV;IAED,YAAY,EAAE,eAAe,CAAC,UAAU,CAAC,CAexC;IAED,IAAI,KAAK,gCAIR;IAED,cAAc;IA+Bd,MAAM;CAkCP;AAED,eAAe,eAAe,CAAA;AAC9B,OAAO,EAAE,eAAe,EAAE,CAAA"}

package/types/RadioInputGroup/props.d.ts

@@ -1,8 +1,16 @@
 import React from 'react';
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
 import type { FormMessage } from '@instructure/ui-form-field';
-import type { OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
+import type { OtherHTMLAttributes, PropValidators, RadioInputGroupTheme } from '@instructure/shared-types';
 import type { WithDeterministicIdProps } from '@instructure/ui-react-utils';
 type RadioInputGroupOwnProps = {
+    /**
+     * This prop sets the
+     * [same low level HTML attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/radio#defining_a_radio_group)
+     *
+     * **Must be unique across the DOM** otherwise groups will interfere with
+     * each other
+     */
     name: string;
     description: React.ReactNode;
     /**
@@ -25,7 +33,7 @@ type RadioInputGroupOwnProps = {
     /**
      * Array of objects with shape: `{
      *   text: ReactNode,
-     *   type: One of: ['error', 'hint', 'success', 'screenreader-only']
+     *   type: One of: ['error', 'newError', 'hint', 'success', 'screenreader-only']
      * }`
      */
     messages?: FormMessage[];
@@ -36,15 +44,20 @@ type RadioInputGroupOwnProps = {
      * any children (ones that aren't `RadioInput` are passed through)
      */
     children?: React.ReactNode;
+    /**
+     * Setting this to `true` adds and asterisk after the description (group label). It does not cause any behavioural change.
+     */
+    isRequired?: boolean;
 };
 type PropKeys = keyof RadioInputGroupOwnProps;
 type AllowedPropKeys = Readonly<Array<PropKeys>>;
-type RadioInputGroupProps = RadioInputGroupOwnProps & OtherHTMLAttributes<RadioInputGroupOwnProps> & WithDeterministicIdProps;
+type RadioInputGroupProps = RadioInputGroupOwnProps & WithStyleProps<RadioInputGroupTheme, RadioInputGroupStyle> & OtherHTMLAttributes<RadioInputGroupOwnProps> & WithDeterministicIdProps;
 type RadioInputGroupState = {
     value?: string | number;
 };
+type RadioInputGroupStyle = ComponentStyle<'invalidAsterisk'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { RadioInputGroupProps, RadioInputGroupState };
+export type { RadioInputGroupProps, RadioInputGroupState, RadioInputGroupStyle };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

package/types/RadioInputGroup/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/RadioInputGroup/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAE3E,KAAK,uBAAuB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,EAAE,KAAK,CAAC,SAAS,CAAA;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAE9E,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IAExB,OAAO,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAE7B,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IAEnC,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAA;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,uBAAuB,CAAA;AAE7C,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,oBAAoB,GAAG,uBAAuB,GACjD,mBAAmB,CAAC,uBAAuB,CAAC,GAAG,wBAAwB,CAAA;AAEzE,KAAK,oBAAoB,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CACxB,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAevC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAanB,CAAA;AAED,YAAY,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,CAAA;AAC1D,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/RadioInputGroup/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACrB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAE3E,KAAK,uBAAuB,GAAG;IAC7B;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,EAAE,KAAK,CAAC,SAAS,CAAA;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAE9E,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IAExB,OAAO,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAE7B,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IAEnC,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAA;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,uBAAuB,CAAA;AAE7C,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,oBAAoB,GAAG,uBAAuB,GACjD,cAAc,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,GAC1D,mBAAmB,CAAC,uBAAuB,CAAC,GAC5C,wBAAwB,CAAA;AAE1B,KAAK,oBAAoB,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CACxB,CAAA;AAED,KAAK,oBAAoB,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAA;AAE7D,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAgBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAanB,CAAA;AAED,YAAY,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,CAAA;AAChF,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/RadioInputGroup/styles.d.ts

@@ -0,0 +1,13 @@
+import type { RadioInputGroupTheme } from '@instructure/shared-types';
+import type { RadioInputGroupStyle } from './props';
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @return {Object} The final style object, which will be used in the component
+ */
+declare const generateStyle: (componentTheme: RadioInputGroupTheme) => RadioInputGroupStyle;
+export default generateStyle;
+//# sourceMappingURL=styles.d.ts.map

package/types/RadioInputGroup/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/RadioInputGroup/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnD;;;;;;;GAOG;AACH,QAAA,MAAM,aAAa,mBACD,oBAAoB,KACnC,oBAQF,CAAA;AAED,eAAe,aAAa,CAAA"}

package/types/RadioInputGroup/theme.d.ts

@@ -0,0 +1,10 @@
+import type { Theme } from '@instructure/ui-themes';
+import { RadioInputGroupTheme } from '@instructure/shared-types';
+/**
+ * Generates the theme object for the component from the theme and provided additional information
+ * @param  {Object} theme The actual theme object.
+ * @return {Object} The final theme object with the overrides and component variables
+ */
+declare const generateComponentTheme: (theme: Theme) => RadioInputGroupTheme;
+export default generateComponentTheme;
+//# sourceMappingURL=theme.d.ts.map

package/types/RadioInputGroup/theme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../src/RadioInputGroup/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAEhE;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,oBAU9C,CAAA;AAED,eAAe,sBAAsB,CAAA"}