Theme

npm_versionnpm Paragon package page

Form auto-suggest enables users to manually select or type to find matching options to partial text input.

Basic Usage

Any Paragon component or export may be added to the code example.

Loading state

Any Paragon component or export may be added to the code example.

Theme Variables#

CSS VariableComputed Value










Props API#

FormAutosuggest Props API
  • arrowKeyNavigationSelector string

    Specifies the CSS selector string that indicates to which elements the user can navigate using the arrow keys

    Default'a:not(:disabled),li:not(:disabled, .btn-icon),input:not(:disabled)'
  • ignoredArrowKeysNames string[]

    Specifies ignored hook keys.

    Default['ArrowRight', 'ArrowLeft']
  • isLoading bool

    Specifies loading state.

    Defaultfalse
  • className string

    Specifies class name to append to the base element.

    Defaultnull
  • floatingLabel string

    Specifies floating label to display for the input component.

    Defaultnull
  • onChange func

    Specifies onChange event handler.

    Defaultnull
  • helpMessage string

    Specifies help information for the user.

    Default''
  • placeholder string

    Specifies the placeholder text for the input.

    Default''
  • value shape {
    userProvidedText: string,
    selectionValue: string,
    selectionId: string,
    }

    Specifies values for the input.

    Defaultnull
  • isValueRequired bool

    Specifies if empty values trigger an error state

    Defaultfalse
  • valueRequiredErrorMessageText requiredWhen(PropTypes.string, 'isValueRequired')

    Informs user they must input a value.

    Defaultnull
  • isSelectionRequired bool

    Specifies if freeform values trigger an error state

    Defaultfalse
  • selectionRequiredErrorMessageText requiredWhen(PropTypes.string, 'isSelectionRequired')

    Informs user they must make a selection.

    Defaultnull
  • hasCustomError bool

    Specifies the control is in a consumer provided error state

    Defaultfalse
  • customErrorMessageText requiredWhen(PropTypes.string, 'hasCustomError')

    Informs user of other errors.

    Defaultnull
  • name string

    Specifies the name of the base input element.

    Default'form-autosuggest'
  • readOnly bool

    Selected list item is read-only.

    Defaultfalse
  • children node

    Specifies the content of the FormAutosuggest.

    Defaultnull
  • screenReaderText string

    Specifies the screen reader text

    Default'loading'
FormAutosuggestOption Props API
  • className string

    Specifies class name to append to the base element.

    Defaultnull
  • children string

    Specifies the text-content of the FormAutosuggestOption.

    Defaultnull
  • onClick func

    A click handler for the FormAutosuggestOption

    Defaultnull

Usage Insights#

FormAutosuggest

Project NameParagon VersionInstance Count
frontend-app-course-authoring22.8.11
frontend-app-support-tools21.13.12

FormAutosuggestOption

Project NameParagon VersionInstance Count
frontend-app-course-authoring22.8.11
frontend-app-support-tools21.13.14