@instructure/ui-range-input 8.14.0 → 8.14.1-snapshot.5

package/types/RangeInput/index.d.ts

@@ -1,28 +1,29 @@
 /** @jsx jsx */
-import { Component } from 'react';
+import React, { Component } from 'react';
 import { jsx } from '@instructure/emotion';
-import type { RangeInputProps } from './props';
+import type { RangeInputProps, RangeInputState } from './props';
 /**
 ---
 category: components
 ---
+@tsProps
 **/
-declare class RangeInput extends Component<RangeInputProps> {
+declare class RangeInput extends Component<RangeInputProps, RangeInputState> {
     static readonly componentId = "RangeInput";
     static allowedProps: readonly (keyof {
         min: number;
         max: number;
         defaultValue?: number | undefined;
-        value?: any;
-        onChange?: ((...args: any[]) => any) | undefined;
+        value?: number | undefined;
+        onChange?: ((value: string | number) => void) | undefined;
         messages?: import("@instructure/ui-form-field/types/FormPropTypes").FormMessage[] | undefined;
         size?: "small" | "medium" | "large" | undefined;
         layout?: "stacked" | "inline" | undefined;
         id?: string | undefined;
-        label: import("react").ReactNode;
+        label: React.ReactNode;
         displayValue?: boolean | undefined;
         step?: number | undefined;
-        formatValue?: ((...args: any[]) => any) | undefined;
+        formatValue?: ((value?: number | undefined, max?: number | undefined) => string) | undefined;
         inline?: boolean | undefined;
         disabled?: boolean | undefined;
         readOnly?: boolean | undefined;
@@ -31,23 +32,23 @@ declare class RangeInput extends Component<RangeInputProps> {
         min: number;
         max: number;
         defaultValue?: number | undefined;
-        value?: any;
-        onChange?: ((...args: any[]) => any) | undefined;
+        value?: number | undefined;
+        onChange?: ((value: string | number) => void) | undefined;
         messages?: import("@instructure/ui-form-field/types/FormPropTypes").FormMessage[] | undefined;
         size?: "small" | "medium" | "large" | undefined;
         layout?: "stacked" | "inline" | undefined;
         id?: string | undefined;
-        label: import("react").ReactNode;
+        label: React.ReactNode;
         displayValue?: boolean | undefined;
         step?: number | undefined;
-        formatValue?: ((...args: any[]) => any) | undefined;
+        formatValue?: ((value?: number | undefined, max?: number | undefined) => string) | undefined;
         inline?: boolean | undefined;
         disabled?: boolean | undefined;
         readOnly?: boolean | undefined;
     }>;
     static defaultProps: {
         step: number;
-        formatValue: (val: any) => any;
+        formatValue: (val?: number | undefined) => number | undefined;
         max: number;
         min: number;
         inline: boolean;
@@ -58,24 +59,21 @@ declare class RangeInput extends Component<RangeInputProps> {
         readOnly: boolean;
     };
     ref: Element | null;
-    _input: HTMLInputElement | null;
-    _inputListener: {
-        remove(): void;
-    } | null;
-    _changeListener: {
-        remove(): void;
-    } | null;
+    private _input;
+    private _inputListener;
+    private _changeListener;
+    private readonly defaultId;
     handleRef: (el: Element | null) => void;
-    constructor(props: any);
+    constructor(props: RangeInputProps);
     componentDidMount(): void;
     componentWillUnmount(): void;
     componentDidUpdate(): void;
-    handleChange: (event: any) => void;
-    noopChange: () => void;
-    get value(): any;
+    handleChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    noopChange: React.ChangeEventHandler<HTMLInputElement>;
+    get value(): number;
     get invalid(): boolean | undefined;
-    get id(): any;
-    renderValue(): jsx.JSX.Element | undefined;
+    get id(): string;
+    renderValue(): jsx.JSX.Element | null;
     render(): jsx.JSX.Element;
 }
 export default RangeInput;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/RangeInput/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAG9C;;;;GAIG;AACH,cAEM,UAAW,SAAQ,SAAS,CAAC,eAAe,CAAC;IACjD,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;;MAYlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAC1B,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAO;IACtC,cAAc,EAAE;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,GAAG,IAAI,CAAO;IAChD,eAAe,EAAE;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,GAAG,IAAI,CAAO;IAEjD,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;gBAGW,KAAK,KAAA;IAejB,iBAAiB;IAkBjB,oBAAoB;IAWpB,kBAAkB;IAKlB,YAAY,uBAUX;IAGD,UAAU,aAAW;IAErB,IAAI,KAAK,QAKR;IAED,IAAI,OAAO,wBAOV;IAED,IAAI,EAAE,QAGL;IAGD,WAAW;IAgBX,MAAM;CA0CP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/RangeInput/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMxC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAOrD,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAG/D;;;;;GAKG;AACH,cAEM,UAAW,SAAQ,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAClE,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;;MAWlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,OAAO,CAAC,MAAM,CAAgC;IAC9C,OAAO,CAAC,cAAc,CAAkC;IACxD,OAAO,CAAC,eAAe,CAAkC;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAQ;IAElC,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;gBAEW,KAAK,EAAE,eAAe;IAalC,iBAAiB;IAkBjB,oBAAoB;IASpB,kBAAkB;IAIlB,YAAY,UAAW,MAAM,WAAW,CAAC,gBAAgB,CAAC,UAUzD;IAGD,UAAU,EAAE,KAAK,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAW;IAEjE,IAAI,KAAK,WAOR;IAED,IAAI,OAAO,wBAOV;IAED,IAAI,EAAE,WAEL;IAED,WAAW;IAsBX,MAAM;CAyCP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}

package/types/RangeInput/props.d.ts

@@ -1,31 +1,53 @@
-import type { OtherHTMLAttributes, PropValidators, RangeInputTheme } from '@instructure/shared-types';
-import type { FormMessage } from '@instructure/ui-form-field';
+import React from 'react';
+import type { OtherHTMLAttributes, PropValidators, RangeInputTheme, PickPropsWithExceptions } from '@instructure/shared-types';
+import type { FormFieldOwnProps, FormMessage } from '@instructure/ui-form-field';
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
-import { InputHTMLAttributes } from 'react';
+import type { InputHTMLAttributes } from 'react';
 declare type RangeInputOwnProps = {
     min: number;
     max: number;
+    /**
+     * value to set on initial render
+     */
     defaultValue?: number;
-    value?: any;
-    onChange?: (...args: any[]) => any;
+    /**
+     * the selected value (must be accompanied by an `onChange` prop)
+     */
+    value?: number;
+    /**
+     * when used with the `value` prop, the component will not control its own state
+     */
+    onChange?: (value: number | string) => void;
     messages?: FormMessage[];
+    /**
+     * The size of the value label
+     */
     size?: 'small' | 'medium' | 'large';
     layout?: 'stacked' | 'inline';
     id?: string;
     label: React.ReactNode;
+    /**
+     * whether to display the current value
+     */
     displayValue?: boolean;
     step?: number;
-    formatValue?: (...args: any[]) => any;
+    /**
+     * A function to format the displayed value
+     */
+    formatValue?: (value?: number, max?: number) => string;
     inline?: boolean;
     disabled?: boolean;
     readOnly?: boolean;
 };
 declare type PropKeys = keyof RangeInputOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type RangeInputProps = RangeInputOwnProps & WithStyleProps<RangeInputTheme, RangeInputStyle> & OtherHTMLAttributes<RangeInputOwnProps, InputHTMLAttributes<RangeInputOwnProps>>;
+declare type RangeInputProps = PickPropsWithExceptions<FormFieldOwnProps, 'label' | 'inline' | 'id' | 'elementRef'> & RangeInputOwnProps & WithStyleProps<RangeInputTheme, RangeInputStyle> & OtherHTMLAttributes<RangeInputOwnProps, InputHTMLAttributes<RangeInputOwnProps>>;
 declare type RangeInputStyle = ComponentStyle<'rangeInput' | 'rangeInputInput' | 'rangeInputInputValue'>;
+declare type RangeInputState = {
+    value?: number | string;
+};
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { RangeInputProps, RangeInputStyle };
+export type { RangeInputProps, RangeInputState, RangeInputStyle };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/RangeInput/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,eAAe,EAChB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAA;AAE3C,aAAK,kBAAkB,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACrC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,kBAAkB,CAAA;AAExC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,eAAe,GAAG,kBAAkB,GACvC,cAAc,CAAC,eAAe,EAAE,eAAe,CAAC,GAChD,mBAAmB,CACjB,kBAAkB,EAClB,mBAAmB,CAAC,kBAAkB,CAAC,CACxC,CAAA;AAEH,aAAK,eAAe,GAAG,cAAc,CACnC,YAAY,GAAG,iBAAiB,GAAG,sBAAsB,CAC1D,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAmCvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAiBnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/RangeInput/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,uBAAuB,EACxB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAChF,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAA;AAEhD,aAAK,kBAAkB,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IAEX,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,KAAK,IAAI,CAAA;IAE3C,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IAEnC,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAE7B,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAEtD,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,kBAAkB,CAAA;AAExC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,eAAe,GAElB,uBAAuB,CACrB,iBAAiB,EACjB,OAAO,GAAG,QAAQ,GAAG,IAAI,GAAG,YAAY,CACzC,GACC,kBAAkB,GAClB,cAAc,CAAC,eAAe,EAAE,eAAe,CAAC,GAChD,mBAAmB,CACjB,kBAAkB,EAClB,mBAAmB,CAAC,kBAAkB,CAAC,CACxC,CAAA;AAEL,aAAK,eAAe,GAAG,cAAc,CACnC,YAAY,GAAG,iBAAiB,GAAG,sBAAsB,CAC1D,CAAA;AAED,aAAK,eAAe,GAAG;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CACxB,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAiBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAiBnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}