Rating provides insight regarding others' opinions and experiences, and can allow the user to submit a rating of their own

Cssproperty

--symbol-size - The size of the symbols.

Cssproperty

--symbol-full-color - The color of the filled symbol.

Cssproperty

--symbol-empty-color - The color of the empty symbol.

Cssproperty

--symbol-full-filter - The filter(s) used for the filled symbol.

Cssproperty

--symbol-empty-filter - The filter(s) used for the empty symbol.

Type Parameters

Hierarchy

Hierarchy

  • Component<P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>, {}>
    • IgrRating

Constructors

  • Type parameters

    Type Parameters

    Parameters

    • props: P & Omit<HTMLAttributes<HTMLElement>, keyof P>

    Returns IgrRating<P>

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get allowReset(): boolean
  • Whether to reset the rating when the user selects the same value.

    Returns boolean

  • set allowReset(v): void
  • Parameters

    • v: boolean

    Returns void

  • get disabled(): boolean
  • The disabled state of the component

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get hoverPreview(): boolean
  • Sets hover preview behavior for the component

    Returns boolean

  • set hoverPreview(v): void
  • Parameters

    • v: boolean

    Returns void

  • get invalid(): boolean
  • Control the validity of the control.

    Returns boolean

  • set invalid(v): void
  • Parameters

    • v: boolean

    Returns void

  • get label(): string
  • The label of the control.

    Returns string

  • set label(v): void
  • Parameters

    • v: string

    Returns void

  • get max(): number
  • The maximum value for the rating. If there are projected symbols, the maximum value will be resolved based on the number of symbols.

    Returns number

  • set max(v): void
  • Parameters

    • v: number

    Returns void

  • get name(): string
  • The name attribute of the control.

    Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get readOnly(): boolean
  • Makes the control a readonly field.

    Returns boolean

  • set readOnly(v): void
  • Parameters

    • v: boolean

    Returns void

  • get single(): boolean
  • Toggles single selection visual mode.

    Returns boolean

  • set single(v): void
  • Parameters

    • v: boolean

    Returns void

  • get step(): number
  • The minimum value change allowed. Valid values are in the interval between 0 and 1 inclusive.

    Returns number

  • set step(v): void
  • Parameters

    • v: number

    Returns void

  • get value(): number
  • The current value of the component

    Returns number

  • set value(v): void
  • Parameters

    • v: number

    Returns void

  • get valueFormat(): string
  • A format string which sets aria-valuetext. Instances of '{0}' will be replaced with the current value of the control and instances of '{1}' with the maximum value for the control. Important for screen-readers and useful for localization.

    Returns string

  • set valueFormat(v): void
  • Parameters

    • v: string

    Returns void

Methods

  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

    Parameters

    • nextProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • nextContext: any

    Returns void

  • Checks for validity of the control and emits the invalid event if it invalid.

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>

    Returns any

  • Returns DOMElement<{
        children: any[];
        class: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["className"];
        id: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["id"];
        ref: ((ref) => void);
        style: {};
    }, any>

  • Checks for validity of the control and shows the browser message if it invalid.

    Returns void

  • Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

    Parameters

    • message: string

    Returns void

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Decrements the value of the control by n steps multiplied by the step factor.

    Parameters

    • Optional n: number

    Returns void

  • Increments the value of the control by n steps multiplied by the step factor.

    Parameters

    • Optional n: number

    Returns void