package.src.components.HelperText.HelperText.tsx Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of react-core Show documentation

This library provides a set of common React components for use with the PatternFly reference implementation.

The newest version!

import * as React from 'react';
import styles from '@patternfly/react-styles/css/components/HelperText/helper-text';
import { css } from '@patternfly/react-styles';

export interface HelperTextProps extends React.HTMLProps {
  /** Content rendered inside the helper text container. */
  children?: React.ReactNode;
  /** Additional classes applied to the helper text container. */
  className?: string;
  /** Component type of the helper text container */
  component?: 'div' | 'ul';
  /** ID for the helper text container. The value of this prop can be passed into a form component's
   * aria-describedby prop when you intend for all helper text items to be announced to
   * assistive technologies.
   */
  id?: string;
  /** Flag for indicating whether the helper text container is a live region. Use this prop when you
   * expect or intend for any helper text items within the container to be dynamically updated.
   */
  isLiveRegion?: boolean;
  /** Adds an accessible label to the helper text when component is a "ul". */
  'aria-label'?: string;
}

export const HelperText: React.FunctionComponent = ({
  children,
  className,
  component = 'div',
  id,
  isLiveRegion = false,
  'aria-label': ariaLabel,
  ...props
}: HelperTextProps) => {
  const Component = component as any;
  return (
    
      {children}
    
  );
};
HelperText.displayName = 'HelperText';