Mixins / foldkit-mixins-ui

RatingInput

interface · packages/mixins-ui/src/rating.ts:55

interface RatingInput<Message> extends RatingCommon<Message> {
  readonly readOnly?: false | undefined
  readonly onChange: (value: number) => NoInfer<Message>
  readonly onClear?: (() => NoInfer<Message>) | undefined
  readonly precision?: 1 | 0.5 | undefined
  readonly disabled?: boolean | undefined
}

A rating that takes a choice.

Members

RatingInput.readOnly

property · packages/mixins-ui/src/rating.ts:56

readonly readOnly?: false | undefined

RatingInput.onChange

property · packages/mixins-ui/src/rating.ts:58

readonly onChange: (value: number) => NoInfer<Message>

The Message for the star chosen; its type comes from h.

RatingInput.onClear

property · packages/mixins-ui/src/rating.ts:60

readonly onClear?: (() => NoInfer<Message>) | undefined

Sent when the star already chosen is pressed again; without it, a press keeps it.

RatingInput.precision

property · packages/mixins-ui/src/rating.ts:62

readonly precision?: 1 | 0.5 | undefined

The step a choice takes: whole stars (default) or halves.

RatingInput.disabled

property · packages/mixins-ui/src/rating.ts:63

readonly disabled?: boolean | undefined