@instructure/ui-select 8.13.1-snapshot.9 → 8.14.1-snapshot.6

package/src/Select/Group/index.tsx

@@ -32,6 +32,7 @@ parent: Select
 id: Select.Group
 ---
 @module Group
+@tsProps
 **/
 class Group extends Component<SelectGroupProps> {
   static readonly componentId = 'Select.Group'
@@ -39,9 +40,7 @@ class Group extends Component<SelectGroupProps> {
   static allowedProps = allowedProps
   static propTypes = propTypes
 
-  static defaultProps = {
-    children: null
-  }
+  static defaultProps = {}
 
   /* istanbul ignore next */
   render() {

package/src/Select/Group/props.ts

@@ -33,8 +33,14 @@ import type {
 } from '@instructure/shared-types'
 
 type SelectGroupOwnProps = {
-  renderLabel: React.ReactNode | ((...args: any[]) => any)
-  children?: React.ReactNode
+  /**
+   * The label associated with the group options.
+   */
+  renderLabel: React.ReactNode | (() => React.ReactNode)
+  /**
+   * Children of type `<SimpleSelect.Option />` that will be considered part of the group.
+   */
+  children?: React.ReactNode // TODO: ChildrenPropTypes.oneOf([Option])
 }
 
 type PropKeys = keyof SelectGroupOwnProps
@@ -45,13 +51,7 @@ type SelectGroupProps = SelectGroupOwnProps &
   OtherHTMLAttributes<SelectGroupOwnProps>
 
 const propTypes: PropValidators<PropKeys> = {
-  /**
-   * The label associated with the group options.
-   */
   renderLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
-  /**
-   * Children of type `<SimpleSelect.Option />` that will be considered part of the group.
-   */
   children: ChildrenPropTypes.oneOf([Option])
 }
 

package/src/Select/Option/index.tsx

@@ -32,6 +32,7 @@ parent: Select
 id: Select.Option
 ---
 @module Option
+@tsProps
 **/
 class Option extends Component<SelectOptionProps> {
   static readonly componentId = 'Select.Option'
@@ -42,8 +43,7 @@ class Option extends Component<SelectOptionProps> {
   static defaultProps = {
     isHighlighted: false,
     isSelected: false,
-    isDisabled: false,
-    children: null
+    isDisabled: false
   }
 
   /* istanbul ignore next */

package/src/Select/Option/props.ts

@@ -21,6 +21,7 @@
  * 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'
 
@@ -29,16 +30,44 @@ import type {
   PropValidators
 } from '@instructure/shared-types'
 
-type SelectOptionOwnProps = {
+type OptionProps = {
+  /**
+   * The id for the option.
+   */
   id: string
+  /**
+   * Whether or not this option is highlighted.
+   */
   isHighlighted?: boolean
+  /**
+   * Whether or not this option is selected.
+   */
   isSelected?: boolean
+  /**
+   * Whether or not this option is disabled.
+   */
   isDisabled?: boolean
-  renderBeforeLabel?: React.ReactNode | ((...args: any[]) => any)
-  renderAfterLabel?: React.ReactNode | ((...args: any[]) => any)
+  /**
+   * Content to display as the option label.
+   */
   children?: React.ReactNode
 }
 
+type RenderSelectOptionLabel =
+  | React.ReactNode
+  | ((args: OptionProps) => React.ReactNode)
+
+type SelectOptionOwnProps = OptionProps & {
+  /**
+   * Content to display before the option label, such as an icon.
+   */
+  renderBeforeLabel?: RenderSelectOptionLabel
+  /**
+   * Content to display after the option label, such as an icon.
+   */
+  renderAfterLabel?: RenderSelectOptionLabel
+}
+
 type PropKeys = keyof SelectOptionOwnProps
 
 type AllowedPropKeys = Readonly<Array<PropKeys>>
@@ -47,33 +76,12 @@ type SelectOptionProps = SelectOptionOwnProps &
   OtherHTMLAttributes<SelectOptionOwnProps>
 
 const propTypes: PropValidators<PropKeys> = {
-  /**
-   * The id for the option.
-   */
   id: PropTypes.string.isRequired,
-  /**
-   * Whether or not this option is highlighted.
-   */
   isHighlighted: PropTypes.bool,
-  /**
-   * Whether or not this option is selected.
-   */
   isSelected: PropTypes.bool,
-  /**
-   * Whether or not this option is disabled.
-   */
   isDisabled: PropTypes.bool,
-  /**
-   * Content to display before the option label, such as an icon.
-   */
   renderBeforeLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-  /**
-   * Content to display after the option label, such as an icon.
-   */
   renderAfterLabel: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-  /**
-   * Content to display as the option label.
-   */
   children: PropTypes.node
 }
 
@@ -87,5 +95,5 @@ const allowedProps: AllowedPropKeys = [
   'children'
 ]
 
-export type { SelectOptionProps }
+export type { SelectOptionProps, RenderSelectOptionLabel }
 export { propTypes, allowedProps }