Mixins / foldkit-mixins-ui

Switch

namespace · packages/mixins-ui/src/switch.ts:1

export * as Switch from './switch.js'

Members

Switch.resolve

function · packages/mixins-ui/src/switch.ts:32

function resolve<Input, Message>(
  attributes: SwitchAttributes<Message>,
  mixins: MixinList<Message>,
  context: ResolveContext<Input, Message>,
): ResolvedSwitch<Message>

Applies mixins to the switch's bundles.

Switch.ResolvedSwitch

type · packages/mixins-ui/src/switch.ts:25

type ResolvedSwitch<Message> = Resolved<
  SwitchAttributes<Message>,
  typeof SwitchSlots,
  Message
>

The switch's bundles with the attached Mixins applied.

Switch.SwitchSlots

const · packages/mixins-ui/src/switch.ts:7

const SwitchSlots: Slots.Contract<{
  readonly button: Slot.UnnamedSlot<
    Capability.Capability<
      'Interactive',
      readonly [Capability.Capability<'Base', readonly []>]
    >,
    readonly [Event.EventToken<'click'>],
    readonly [
      Attr.AttrToken<'role'>,
      Attr.AttrToken<'aria-disabled'>,
      Attr.AttrToken<'disabled'>,
      Attr.AttrToken<'value'>,
    ],
    readonly Slot.RequirementName[],
    boolean
  >
  readonly label: Slot.UnnamedSlot<
    Capability.Capability<
      'Container',
      readonly [
        Capability.Capability<
          'Interactive',
          readonly [Capability.Capability<'Base', readonly []>]
        >,
      ]
    >,
    readonly [Event.EventToken<'click'>],
    readonly Slot.AttributeName[],
    readonly Slot.RequirementName[],
    boolean
  >
  readonly description: Slot.UnnamedSlot<
    Capability.Capability<
      'Container',
      readonly [
        Capability.Capability<
          'Interactive',
          readonly [Capability.Capability<'Base', readonly []>]
        >,
      ]
    >,
    readonly Slot.EventName[],
    readonly Slot.AttributeName[],
    readonly Slot.RequirementName[],
    boolean
  >
  readonly hiddenInput: Slot.UnnamedSlot<
    Capability.Capability<'Base', readonly []>,
    readonly Slot.EventName[],
    readonly [Attr.AttrToken<'value'>],
    readonly Slot.RequirementName[],
    boolean
  >
}>

Mirrors the checkbox contract: both the control and its label own click.

Switch.toView

function · packages/mixins-ui/src/switch.ts:39

function toView<Message>(
  mixins: MixinList<Message>,
  context: ResolveContext<unknown, Message>,
  draw: (resolved: ResolvedSwitch<Message>) => Html,
): (attributes: SwitchAttributes<Message>) => Html

The switch's toView: draw receives its bundles with mixins applied.