Documentation navigation

Published API · 0.1.0-rc.1

themes · components/tabs

Published themes API declarations for components/tabs.

./components/tabs

@wsagency/wseffect-themes · MIT · source · MIT license · WS-AGENCY-NOTICE

This entry point is published in @wsagency/wseffect-themes@0.1.0-rc.1. Import it from the package subpath shown below; the signatures and documentation are read from the installed package declarations.

import * as Wseffect from '@wsagency/wseffect-themes/components/tabs'

Exported declarations

Bundle

export type Bundle<Value extends string> = Readonly<{
    Model: typeof UiTabs.Model;
    Message: typeof UiTabs.Message;
    OutMessage: typeof UiTabs.OutMessage;
    init: typeof UiTabs.init;
    update: UiTabs.Bundle<Value>['update'];
    view: (model: UiTabs.Model, inputs: ThemedViewInputs<Value>, h: HtmlBuilder<UiTabs.Message>) => Html;
    fold: <ParentModel, ParentMessage, ParentOutMessage>(config: Omit<Update.ChildFoldWithDerivedParentOutMessage<ParentModel, ParentMessage, UiTabs.Model, UiTabs.Message, UiTabs.Message, UiTabs.OutMessage<Value>, ParentOutMessage>, 'update'>) => Update.FoldWithOutMessage<ParentModel, ParentMessage, UiTabs.Message, ParentOutMessage>;
    embed: <ParentMessage>(h: HtmlBuilder<ParentMessage>, config: EmbedConfig<Value, ParentMessage>) => Html;
}>;

create

create: <Value extends string>() => Bundle<Value>

EmbedConfig

export type EmbedConfig<Value extends string, ParentMessage> = Readonly<{
    slotId: string;
    model: UiTabs.Model;
    toParentMessage: (message: UiTabs.Message) => ParentMessage;
    viewInputs: ThemedViewInputs<Value>;
}>;

ThemedViewInputs

export type ThemedViewInputs<Value extends string> = Omit<TabsViewInputs<Value>, 'toView'> & Readonly<{
    tabToLabel: (value: Value) => Html;
    tabToPanel: (value: Value) => ReadonlyArray<Html | string>;
}>;

Rendered component example

Tabs
Project overview
Example usage
import * as Themes from '@wsagency/wseffect-themes'
import * as SliderRange from '@wsagency/wseffect-themes/components/slider/range'
import * as Option from 'effect/Option'
import { defineView } from '@wsagency/wseffect-foldkit/submodel'
import { inertHtml, type HtmlBuilder } from '@wsagency/wseffect-foldkit/html'

const example = (h: HtmlBuilder<unknown>) => (() => { const tabs = Themes.Tabs.create<'overview' | 'activity'>(); const model = tabs.init({ id: 'project-tabs-example' }); return tabs.embed(h, { slotId: 'project-tabs-example', model, toParentMessage: (message) => message, viewInputs: { tabs: ['overview', 'activity'], selectedValue: 'overview', ariaLabel: 'Project sections', tabToLabel: (value) => h.span([], [value === 'overview' ? 'Overview' : 'Activity']), tabToPanel: (value) => [value === 'overview' ? 'Project overview' : 'Recent activity'] } }) })()