@instructure/ui-form-field 8.8.1-snapshot.8 → 8.9.0

package/src/FormFieldLayout/props.ts

@@ -0,0 +1,97 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import PropTypes from 'prop-types'
+
+import { FormPropTypes } from '../FormPropTypes'
+
+import type { AsElementType, PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+import type { FormMessage } from '../FormPropTypes'
+
+type FormFieldLayoutOwnProps = {
+  label: React.ReactNode
+  id?: string
+  as?: AsElementType
+  messages?: FormMessage[]
+  messagesId?: string
+  children?: React.ReactNode
+  inline?: boolean
+  layout?: 'stacked' | 'inline'
+  labelAlign?: 'start' | 'end'
+  width?: string
+  inputContainerRef?: (...args: any[]) => any
+}
+
+type PropKeys = keyof FormFieldLayoutOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FormFieldLayoutProps = FormFieldLayoutOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  label: PropTypes.node.isRequired,
+  /**
+   * the id of the input (to link it to its label for a11y)
+   */
+  id: PropTypes.string,
+  /**
+   * the element type to render as
+   */
+  as: PropTypes.elementType,
+  /**
+   * object with shape: `{
+   * text: PropTypes.string,
+   * type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
+   *   }`
+   */
+  messages: PropTypes.arrayOf(FormPropTypes.message),
+  /**
+   * id for the form field messages
+   */
+  messagesId: PropTypes.string,
+  children: PropTypes.node,
+  inline: PropTypes.bool,
+  layout: PropTypes.oneOf(['stacked', 'inline']),
+  labelAlign: PropTypes.oneOf(['start', 'end']),
+  width: PropTypes.string,
+  inputContainerRef: PropTypes.func
+}
+
+const allowedProps: AllowedPropKeys = [
+  'label',
+  'id',
+  'as',
+  'messages',
+  'messagesId',
+  'children',
+  'inline',
+  'layout',
+  'labelAlign',
+  'width',
+  'inputContainerRef'
+]
+
+export type { FormFieldLayoutProps }
+export { propTypes, allowedProps }

package/src/FormFieldLayout/styles.ts

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 
-import { FormFieldLayoutProps } from './types'
+import { FormFieldLayoutProps } from './props'
 
 /**
  * ---

package/src/FormFieldMessage/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { ScreenReaderContent } from '@instructure/ui-a11y-content'
 
@@ -32,7 +31,9 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { FormFieldMessageProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { FormFieldMessageProps } from './props'
 
 /**
 ---
@@ -53,15 +54,8 @@ example: true
 class FormFieldMessage extends Component<FormFieldMessageProps> {
   static readonly componentId = 'FormFieldMessage'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    variant: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only']),
-    children: PropTypes.node
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     variant: 'hint',
     children: null
@@ -82,7 +76,7 @@ class FormFieldMessage extends Component<FormFieldMessageProps> {
     const { children, styles } = this.props
 
     return this.props.variant !== 'screenreader-only' ? (
-      <span css={styles.formFieldMessage}>{children}</span>
+      <span css={styles?.formFieldMessage}>{children}</span>
     ) : (
       <ScreenReaderContent>{children}</ScreenReaderContent>
     )

package/src/FormFieldMessage/props.ts

@@ -0,0 +1,50 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import PropTypes from 'prop-types'
+
+import type { PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+import type { FormMessageType } from '../FormPropTypes'
+
+type FormFieldMessageOwnProps = {
+  variant?: FormMessageType
+  children?: React.ReactNode
+}
+
+type PropKeys = keyof FormFieldMessageOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FormFieldMessageProps = FormFieldMessageOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  variant: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only']),
+  children: PropTypes.node
+}
+
+const allowedProps: AllowedPropKeys = ['variant', 'children']
+
+export type { FormFieldMessageProps }
+export { propTypes, allowedProps }

package/src/FormFieldMessage/styles.ts

@@ -23,7 +23,7 @@
  */
 
 import { FormFieldMessageTheme } from '@instructure/shared-types'
-import { FormFieldMessageProps } from './types'
+import { FormFieldMessageProps } from './props'
 import { FormMessageType } from '../FormPropTypes'
 
 /**

package/src/FormFieldMessages/index.tsx

@@ -24,18 +24,18 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { omitProps } from '@instructure/ui-react-utils'
 
 import { withStyle, jsx } from '@instructure/emotion'
 
-import { FormPropTypes } from '../FormPropTypes'
 import { FormFieldMessage } from '../FormFieldMessage'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { FormFieldMessagesProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { FormFieldMessagesProps } from './props'
 
 /**
 ---
@@ -59,23 +59,9 @@ example: true
 class FormFieldMessages extends Component<FormFieldMessagesProps> {
   static readonly componentId = 'FormFieldMessages'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    /**
-     * object with shape: `{
-     * text: PropTypes.string,
-     * type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
-     *   }`
-     */
-    messages: PropTypes.arrayOf(FormPropTypes.message)
-  }
-
-  static defaultProps = {
-    messages: undefined
-  }
+  static propTypes = propTypes
+  static allowedProps = allowedProps
+  static defaultProps = {}
 
   componentDidMount() {
     // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
@@ -93,12 +79,12 @@ class FormFieldMessages extends Component<FormFieldMessagesProps> {
 
     return messages && messages.length > 0 ? (
       <span
-        css={styles.formFieldMessages}
+        css={styles?.formFieldMessages}
         {...omitProps(this.props, FormFieldMessages.propTypes)}
       >
         {messages.map((msg, i) => {
           return (
-            <span key={`error${i}`} css={styles.message}>
+            <span key={`error${i}`} css={styles?.message}>
               <FormFieldMessage variant={msg.type}>{msg.text}</FormFieldMessage>
             </span>
           )

package/src/FormFieldMessages/props.ts

@@ -0,0 +1,56 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import PropTypes from 'prop-types'
+
+import { FormPropTypes } from '../FormPropTypes'
+
+import type { PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+import type { FormMessage } from '../FormPropTypes'
+
+type FormFieldMessagesOwnProps = {
+  messages?: FormMessage[]
+}
+
+type PropKeys = keyof FormFieldMessagesOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FormFieldMessagesProps = FormFieldMessagesOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * object with shape: `{
+   * text: PropTypes.string,
+   * type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
+   *   }`
+   */
+  messages: PropTypes.arrayOf(FormPropTypes.message)
+}
+
+const allowedProps: AllowedPropKeys = ['messages']
+
+export type { FormFieldMessagesProps }
+export { propTypes, allowedProps }

package/src/index.ts

@@ -32,9 +32,9 @@ export { FormFieldGroup } from './FormFieldGroup'
 export { FormPropTypes } from './FormPropTypes'
 export type { FormMessageType, FormMessage } from './FormPropTypes'
 
-export type { FormFieldProps } from './FormField/types'
-export type { FormFieldLabelProps } from './FormFieldLabel/types'
-export type { FormFieldMessageProps } from './FormFieldMessage/types'
-export type { FormFieldMessagesProps } from './FormFieldMessages/types'
-export type { FormFieldLayoutProps } from './FormFieldLayout/types'
-export type { FormFieldGroupProps } from './FormFieldGroup/types'
+export type { FormFieldProps } from './FormField/props'
+export type { FormFieldLabelProps } from './FormFieldLabel/props'
+export type { FormFieldMessageProps } from './FormFieldMessage/props'
+export type { FormFieldMessagesProps } from './FormFieldMessages/props'
+export type { FormFieldLayoutProps } from './FormFieldLayout/props'
+export type { FormFieldGroupProps } from './FormFieldGroup/props'

package/types/FormField/index.d.ts

@@ -1,6 +1,5 @@
-import { Component } from 'react';
-import PropTypes from 'prop-types';
-import { FormFieldProps } from './types';
+import React, { Component } from 'react';
+import type { FormFieldProps } from './props';
 /**
 ---
 category: components
@@ -8,41 +7,38 @@ category: components
 **/
 declare class FormField extends Component<FormFieldProps> {
     static readonly componentId = "FormField";
-    static propTypes: {
-        label: PropTypes.Validator<string | number | boolean | {} | PropTypes.ReactElementLike | PropTypes.ReactNodeArray>;
-        /**
-         * the id of the input (to link it to its label for a11y)
-         */
-        id: PropTypes.Validator<string>;
-        /**
-         * object with shape: `{
-         *   text: PropTypes.string,
-         *   type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
-         * }`
-         */
-        messages: PropTypes.Requireable<(PropTypes.InferProps<{
-            text: PropTypes.Requireable<string>;
-            type: PropTypes.Requireable<string>;
-        }> | null | undefined)[]>;
-        messagesId: PropTypes.Requireable<string>;
-        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        inline: PropTypes.Requireable<boolean>;
-        layout: PropTypes.Requireable<string>;
-        labelAlign: PropTypes.Requireable<string>;
-        vAlign: PropTypes.Requireable<string>;
-        width: PropTypes.Requireable<string>;
-        inputContainerRef: PropTypes.Requireable<(...args: any[]) => any>;
-    };
+    static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
+        label: React.ReactNode;
+        id: string;
+        messages?: import("..").FormMessage[] | undefined;
+        messagesId?: string | undefined;
+        children?: React.ReactNode;
+        inline?: boolean | undefined;
+        layout?: "inline" | "stacked" | undefined;
+        labelAlign?: "end" | "start" | undefined;
+        vAlign?: "middle" | "bottom" | "top" | undefined;
+        width?: string | undefined;
+        inputContainerRef?: ((...args: any[]) => any) | undefined;
+    }>;
+    static allowedProps: readonly (keyof {
+        label: React.ReactNode;
+        id: string;
+        messages?: import("..").FormMessage[] | undefined;
+        messagesId?: string | undefined;
+        children?: React.ReactNode;
+        inline?: boolean | undefined;
+        layout?: "inline" | "stacked" | undefined;
+        labelAlign?: "end" | "start" | undefined;
+        vAlign?: "middle" | "bottom" | "top" | undefined;
+        width?: string | undefined;
+        inputContainerRef?: ((...args: any[]) => any) | undefined;
+    })[];
     static defaultProps: {
         inline: boolean;
         layout: string;
         labelAlign: string;
         vAlign: string;
-        messages: undefined;
-        messagesId: undefined;
         children: null;
-        width: undefined;
-        inputContainerRef: undefined;
     };
     render(): JSX.Element;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormField/index.tsx"],"names":[],"mappings":"AAwBA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACxC,OAAO,SAAS,MAAM,YAAY,CAAA;AAMlC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC;;;;GAIG;AACH,cAAM,SAAU,SAAQ,SAAS,CAAC,cAAc,CAAC;IAC/C,MAAM,CAAC,QAAQ,CAAC,WAAW,eAAc;IAEzC,MAAM,CAAC,SAAS;;QAEd;;WAEG;;QAEH;;;;;WAKG;;;;;;;;;;;;;MAUJ;IAED,MAAM,CAAC,YAAY;;;;;;;;;;MAUlB;IAED,MAAM;CAYP;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormField/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAOxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C;;;;GAIG;AACH,cAAM,SAAU,SAAQ,SAAS,CAAC,cAAc,CAAC;IAC/C,MAAM,CAAC,QAAQ,CAAC,WAAW,eAAc;IAEzC,MAAM,CAAC,SAAS;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;MAMlB;IAED,MAAM;CAYP;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/types/FormField/props.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import type { PropValidators } from '@instructure/shared-types';
+import type { FormMessage } from '../FormPropTypes';
+declare type FormFieldOwnProps = {
+    label: React.ReactNode;
+    id: string;
+    messages?: FormMessage[];
+    messagesId?: string;
+    children?: React.ReactNode;
+    inline?: boolean;
+    layout?: 'stacked' | 'inline';
+    labelAlign?: 'start' | 'end';
+    vAlign?: 'top' | 'middle' | 'bottom';
+    width?: string;
+    inputContainerRef?: (...args: any[]) => any;
+};
+declare type PropKeys = keyof FormFieldOwnProps;
+declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
+declare type FormFieldProps = FormFieldOwnProps;
+declare const propTypes: PropValidators<PropKeys>;
+declare const allowedProps: AllowedPropKeys;
+export type { FormFieldProps };
+export { propTypes, allowedProps };
+//# sourceMappingURL=props.d.ts.map