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

package/src/FormField/props.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 React from 'react'
+import PropTypes from 'prop-types'
+
+import { FormPropTypes } from '../FormPropTypes'
+
+import type { PropValidators } from '@instructure/shared-types'
+import type { FormMessage } from '../FormPropTypes'
+
+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
+}
+
+type PropKeys = keyof FormFieldOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FormFieldProps = FormFieldOwnProps
+
+const propTypes: PropValidators<PropKeys> = {
+  label: PropTypes.node.isRequired,
+  /**
+   * the id of the input (to link it to its label for a11y)
+   */
+  id: PropTypes.string.isRequired,
+  /**
+   * object with shape: `{
+   *   text: PropTypes.string,
+   *   type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])
+   * }`
+   */
+  messages: PropTypes.arrayOf(FormPropTypes.message),
+  messagesId: PropTypes.string,
+  children: PropTypes.node,
+  inline: PropTypes.bool,
+  layout: PropTypes.oneOf(['stacked', 'inline']),
+  labelAlign: PropTypes.oneOf(['start', 'end']),
+  vAlign: PropTypes.oneOf(['top', 'middle', 'bottom']),
+  width: PropTypes.string,
+  inputContainerRef: PropTypes.func
+}
+
+const allowedProps: AllowedPropKeys = [
+  'label',
+  'id',
+  'messages',
+  'messagesId',
+  'children',
+  'inline',
+  'layout',
+  'labelAlign',
+  'vAlign',
+  'width',
+  'inputContainerRef'
+]
+
+export type { FormFieldProps }
+export { propTypes, allowedProps }

package/src/FormFieldGroup/index.tsx

@@ -24,18 +24,18 @@
 
 /** @jsx jsx */
 import { Component, Children } from 'react'
-import PropTypes from 'prop-types'
 
 import { Grid } from '@instructure/ui-grid'
 import { pickProps, omitProps } from '@instructure/ui-react-utils'
 import { withStyle, jsx } from '@instructure/emotion'
 
 import { FormFieldLayout } from '../FormFieldLayout'
-import { FormPropTypes } from '../FormPropTypes'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { FormFieldGroupProps, FormFieldGroupStyleProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { FormFieldGroupProps, FormFieldGroupStyleProps } from './props'
 
 /**
 ---
@@ -46,42 +46,10 @@ category: components
 class FormFieldGroup extends Component<FormFieldGroupProps> {
   static readonly componentId = 'FormFieldGroup'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    description: PropTypes.node.isRequired,
-    /**
-     * 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,
-    disabled: PropTypes.bool,
-    children: PropTypes.node,
-    layout: PropTypes.oneOf(['stacked', 'columns', 'inline']),
-    rowSpacing: PropTypes.oneOf(['none', 'small', 'medium', 'large']),
-    colSpacing: PropTypes.oneOf(['none', 'small', 'medium', 'large']),
-    vAlign: PropTypes.oneOf(['top', 'middle', 'bottom']),
-    startAt: PropTypes.oneOf(['small', 'medium', 'large', 'x-large', null])
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     children: null,
-    layout: undefined,
-    startAt: undefined,
-    messages: undefined,
-    messagesId: undefined,
     as: 'fieldset',
     disabled: false,
     rowSpacing: 'medium',
@@ -147,7 +115,7 @@ class FormFieldGroup extends Component<FormFieldGroupProps> {
     const { styles } = this.props
 
     return (
-      <span key="fields" css={styles.formFieldGroup}>
+      <span key="fields" css={styles?.formFieldGroup}>
         {this.renderChildren()}
       </span>
     )

package/src/FormFieldGroup/props.ts

@@ -0,0 +1,98 @@
+/*
+ * 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 FormFieldGroupOwnProps = {
+  description: React.ReactNode
+  as?: AsElementType
+  messages?: FormMessage[]
+  messagesId?: string
+  disabled?: boolean
+  children?: React.ReactNode
+  layout?: 'stacked' | 'columns' | 'inline'
+  rowSpacing?: 'none' | 'small' | 'medium' | 'large'
+  colSpacing?: 'none' | 'small' | 'medium' | 'large'
+  vAlign?: 'top' | 'middle' | 'bottom'
+  startAt?: any // TODO: PropTypes.oneOf(['small', 'medium', 'large', 'x-large', null])
+}
+
+type FormFieldGroupStyleProps = {
+  invalid: boolean
+}
+
+type PropKeys = keyof FormFieldGroupOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FormFieldGroupProps = FormFieldGroupOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  description: PropTypes.node.isRequired,
+  /**
+   * 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,
+  disabled: PropTypes.bool,
+  children: PropTypes.node,
+  layout: PropTypes.oneOf(['stacked', 'columns', 'inline']),
+  rowSpacing: PropTypes.oneOf(['none', 'small', 'medium', 'large']),
+  colSpacing: PropTypes.oneOf(['none', 'small', 'medium', 'large']),
+  vAlign: PropTypes.oneOf(['top', 'middle', 'bottom']),
+  startAt: PropTypes.oneOf(['small', 'medium', 'large', 'x-large', null])
+}
+
+const allowedProps: AllowedPropKeys = [
+  'description',
+  'as',
+  'messages',
+  'messagesId',
+  'disabled',
+  'children',
+  'layout',
+  'rowSpacing',
+  'colSpacing',
+  'vAlign',
+  'startAt'
+]
+
+export type { FormFieldGroupProps, FormFieldGroupStyleProps }
+export { propTypes, allowedProps }

package/src/FormFieldGroup/styles.ts

@@ -23,7 +23,7 @@
  */
 
 import { FormFieldGroupTheme } from '@instructure/shared-types'
-import { FormFieldGroupProps, FormFieldGroupStyleProps } from './types'
+import { FormFieldGroupProps, FormFieldGroupStyleProps } from './props'
 
 /**
  * ---

package/src/FormFieldLabel/index.tsx

@@ -24,14 +24,15 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { omitProps, getElementType } from '@instructure/ui-react-utils'
 import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { FormFieldLabelProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { FormFieldLabelProps } from './props'
 
 /**
 ---
@@ -53,18 +54,11 @@ example: true
 class FormFieldLabel extends Component<FormFieldLabelProps> {
   static readonly componentId = 'FormFieldLabel'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    as: PropTypes.elementType,
-    children: PropTypes.node.isRequired
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
     as: 'span'
-  }
+  } as const
 
   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
@@ -85,7 +79,7 @@ class FormFieldLabel extends Component<FormFieldLabelProps> {
     return (
       <ElementType
         {...omitProps(this.props, FormFieldLabel.propTypes)}
-        css={styles.formFieldLabel}
+        css={styles?.formFieldLabel}
       >
         {children}
       </ElementType>

package/src/{FormFieldGroup/types.ts → FormFieldLabel/props.ts}

@@ -22,24 +22,28 @@
  * SOFTWARE.
  */
 
-import { AsElementType } from '@instructure/shared-types'
-import { FormMessage } from '../FormPropTypes'
+import PropTypes from 'prop-types'
 
-export type FormFieldGroupProps = {
-  makeStyles?: (...args: any[]) => any
-  styles?: any
-  description: React.ReactNode
+import type { AsElementType, PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+
+type FormFieldLabelOwnProps = {
   as?: AsElementType
-  messages?: FormMessage[]
-  messagesId?: string
-  disabled?: boolean
-  layout?: 'stacked' | 'columns' | 'inline'
-  rowSpacing?: 'none' | 'small' | 'medium' | 'large'
-  colSpacing?: 'none' | 'small' | 'medium' | 'large'
-  vAlign?: 'top' | 'middle' | 'bottom'
-  startAt?: any // TODO: PropTypes.oneOf(['small', 'medium', 'large', 'x-large', null])
+  children: React.ReactNode
 }
 
-export type FormFieldGroupStyleProps = {
-  invalid: boolean
+type PropKeys = keyof FormFieldLabelOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type FormFieldLabelProps = FormFieldLabelOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  as: PropTypes.elementType,
+  children: PropTypes.node.isRequired
 }
+
+const allowedProps: AllowedPropKeys = ['as', 'children']
+
+export type { FormFieldLabelProps }
+export { propTypes, allowedProps }

package/src/FormFieldLabel/styles.ts

@@ -24,7 +24,7 @@
 
 import { hasVisibleChildren } from '@instructure/ui-a11y-utils'
 import { FormFieldLabelTheme } from '@instructure/shared-types'
-import { FormFieldLabelProps } from './types'
+import { FormFieldLabelProps } from './props'
 
 /**
  * ---

package/src/FormFieldLayout/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { hasVisibleChildren } from '@instructure/ui-a11y-utils'
 import { ScreenReaderContent } from '@instructure/ui-a11y-content'
@@ -41,10 +40,11 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import { FormFieldLabel } from '../FormFieldLabel'
 import { FormFieldMessages } from '../FormFieldMessages'
-import { FormPropTypes } from '../FormPropTypes'
 
 import generateStyle from './styles'
-import { FormFieldLayoutProps } from './types'
+
+import { propTypes, allowedProps } from './props'
+import type { FormFieldLayoutProps } from './props'
 
 /**
 ---
@@ -55,51 +55,15 @@ parent: FormField
 class FormFieldLayout extends Component<FormFieldLayoutProps> {
   static readonly componentId = 'FormFieldLayout'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    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
-  }
-
+  static propTypes = propTypes
+  static allowedProps = allowedProps
   static defaultProps = {
-    id: undefined,
-    width: undefined,
-    messages: undefined,
-    messagesId: undefined,
     children: null,
     inline: false,
     layout: 'stacked',
     as: 'label',
-    labelAlign: 'end',
-    inputContainerRef: undefined
-  }
+    labelAlign: 'end'
+  } as const
 
   // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'props' implicitly has an 'any' type.
   constructor(props) {
@@ -218,7 +182,7 @@ class FormFieldLayout extends Component<FormFieldLayoutProps> {
           ...FormFieldLayout.propTypes,
           ...Grid.propTypes
         })}
-        css={styles.formFieldLayout}
+        css={styles?.formFieldLayout}
         style={{ width }}
         // @ts-expect-error ts-migrate(2339) FIXME: Property '_messagesId' does not exist on type 'For... Remove this comment to see the full error message
         aria-describedby={this.hasMessages ? this._messagesId : null}