Mixins / foldkit-mixins-ui

MarqueeView

interface · packages/mixins-ui/src/marquee.ts:101

interface MarqueeView<Message> {
  readonly model: Model
  readonly onMessage: (message: typeof Message.Type) => NoInfer<Message>
  readonly label: string
  readonly items: ReadonlyArray<Html>
  readonly side?: MarqueeSide | undefined
  readonly speed?: number | undefined
  readonly delay?: number | undefined
  readonly loopCount?: number | undefined
  readonly pauseOnInteraction?: boolean | undefined
  readonly autoFill?: boolean | undefined
  readonly repeat?: number | undefined
  readonly controls?: boolean | undefined
  readonly pauseLabels?:
    | {
        readonly pause: string
        readonly play: string
      }
    | undefined
  readonly style?: NamedStyle<typeof MarqueeSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

MarqueeView.model

property · packages/mixins-ui/src/marquee.ts:102

readonly model: Model

MarqueeView.onMessage

property · packages/mixins-ui/src/marquee.ts:104

readonly onMessage: (message: typeof Message.Type) => NoInfer<Message>

Lifts the marquee's own Messages into the application's.

MarqueeView.label

property · packages/mixins-ui/src/marquee.ts:106

readonly label: string

What scrolls by, naming the region.

MarqueeView.items

property · packages/mixins-ui/src/marquee.ts:107

readonly items: ReadonlyArray<Html>

MarqueeView.side

property · packages/mixins-ui/src/marquee.ts:109

readonly side?: MarqueeSide | undefined

Default start: toward the inline start, so leftward left to right.

MarqueeView.speed

property · packages/mixins-ui/src/marquee.ts:111

readonly speed?: number | undefined

Pixels a second; default 50.

MarqueeView.delay

property · packages/mixins-ui/src/marquee.ts:113

readonly delay?: number | undefined

Seconds before it first moves; default 0.

MarqueeView.loopCount

property · packages/mixins-ui/src/marquee.ts:115

readonly loopCount?: number | undefined

Times it goes round before it stops; default none, round for good.

MarqueeView.pauseOnInteraction

property · packages/mixins-ui/src/marquee.ts:117

readonly pauseOnInteraction?: boolean | undefined

A pointer over it, or focus inside it, pauses it; default true.

MarqueeView.autoFill

property · packages/mixins-ui/src/marquee.ts:119

readonly autoFill?: boolean | undefined

Draws as many copies as fill the viewport, and one more; default true.

MarqueeView.repeat

property · packages/mixins-ui/src/marquee.ts:121

readonly repeat?: number | undefined

The fewest copies drawn, measured or not; default 2, the fewest a seamless loop needs.

MarqueeView.controls

property · packages/mixins-ui/src/marquee.ts:123

readonly controls?: boolean | undefined

Draws the pause press; default true.

MarqueeView.pauseLabels

property · packages/mixins-ui/src/marquee.ts:125

readonly pauseLabels?:
  | {
      readonly pause: string
      readonly play: string
    }
  | undefined

The pause press's words; default Pause and Play.

MarqueeView.style

property · packages/mixins-ui/src/marquee.ts:127

readonly style?: NamedStyle<typeof MarqueeSlots> | undefined

A style of MarqueeSlots, for the look.

MarqueeView.mixins

property · packages/mixins-ui/src/marquee.ts:129

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.