Mixins / foldkit-mixins-ui

Checkbox

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

export * as Checkbox from './checkbox.js'

Members

Checkbox.CheckboxSlots

const · packages/mixins-ui/src/checkbox.ts:11

const CheckboxSlots: Slots.Contract<{
  readonly checkbox: 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
  >
}>

Both the control and its label carry the base toggle handlers, so both own click. hiddenInput exists only when a form name is configured; its base bundle is then empty.

Checkbox.resolve

function · packages/mixins-ui/src/checkbox.ts:36

function resolve<Input, Message>(
  attributes: CheckboxAttributes<Message>,
  mixins: MixinList<Message>,
  context: ResolveContext<Input, Message>,
): ResolvedCheckbox<Message>

Applies mixins to the checkbox's bundles.

Checkbox.ResolvedCheckbox

type · packages/mixins-ui/src/checkbox.ts:29

type ResolvedCheckbox<Message> = Resolved<
  CheckboxAttributes<Message>,
  typeof CheckboxSlots,
  Message
>

The checkbox's bundles with the attached Mixins applied.

Checkbox.toView

function · packages/mixins-ui/src/checkbox.ts:43

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

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