Documentation navigation

Published API · 0.1.0-rc.1

themes · components/data-list

Published themes API declarations for components/data-list.

./components/data-list

@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/data-list'

Exported declarations

Item

Item: {
    Props: Schema.Struct<{
        readonly align: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
    }>;
    view: <M>(props: typeof itemProps.Type, children: ReadonlyArray<Html | string>, h: HtmlBuilder<M>) => Html;
}

Label

Label: {
    Props: Schema.Struct<{
        readonly width: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly minWidth: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly maxWidth: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly color: Schema.optional<Schema.Literals<readonly ["gray", "gold", "bronze", "brown", "yellow", "amber", "orange", "tomato", "red", "ruby", "crimson", "pink", "plum", "purple", "violet", "iris", "indigo", "blue", "cyan", "teal", "jade", "green", "grass", "lime", "mint", "sky", "custom"]>>;
        readonly highContrast: Schema.optional<Schema.Boolean>;
    }>;
    view: <M>(props: typeof labelProps.Type, children: ReadonlyArray<Html | string>, h: HtmlBuilder<M>) => Html;
}

Root

Root: {
    Props: Schema.Struct<{
        readonly m: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly mx: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly my: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly mt: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly mr: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly mb: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly ml: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly orientation: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly size: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly trim: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
    }>;
    view: <M>(props: typeof rootProps.Type, children: ReadonlyArray<Html | string>, h: HtmlBuilder<M>) => Html;
}

Value

Value: {
    Props: Schema.Struct<{}>;
    view: <M>(_props: typeof emptyProps.Type, children: ReadonlyArray<Html | string>, h: HtmlBuilder<M>) => Html;
}

Item.Props

Props exported by @wsagency/wseffect-themes/components/data-list · Item.Props · source
NameTypeRequiredChoicesDescription
align"start" | "center" | "end" | "baseline" | "stretch" | Responsive<"start" | "center" | "end" | "baseline" | "stretch">No——

Label.Props

Props exported by @wsagency/wseffect-themes/components/data-list · Label.Props · source
NameTypeRequiredChoicesDescription
widthstring | Responsive<string>No——
minWidthstring | Responsive<string>No——
maxWidthstring | Responsive<string>No——
color"gray" | "gold" | "bronze" | "brown" | "yellow" | "amber" | "orange" | "tomato" | "red" | "ruby" | "crimson" | "pink" | "plum" | "purple" | "violet" | "iris" | "indigo" | "blue" | "cyan" | "teal" | "jade" | "green" | "grass" | "lime" | "mint" | "sky" | "custom"No"gray", "gold", "bronze", "brown", "yellow", "amber", "orange", "tomato", "red", "ruby", "crimson", "pink", "plum", "purple", "violet", "iris", "indigo", "blue", "cyan", "teal", "jade", "green", "grass", "lime", "mint", "sky", "custom"—
highContrastbooleanNo——

Root.Props

Props exported by @wsagency/wseffect-themes/components/data-list · Root.Props · source
NameTypeRequiredChoicesDescription
orientation"horizontal" | "vertical" | Responsive<"horizontal" | "vertical">No——
size"1" | "2" | "3" | Responsive<"1" | "2" | "3">No——
trim"normal" | "start" | "end" | "both" | Responsive<"normal" | "start" | "end" | "both">No——
mstring | Responsive<string>No——
mxstring | Responsive<string>No——
mystring | Responsive<string>No——
mtstring | Responsive<string>No——
mrstring | Responsive<string>No——
mbstring | Responsive<string>No——
mlstring | Responsive<string>No——

Value.Props

Props exported by @wsagency/wseffect-themes/components/data-list · Value.Props · source
NameTypeRequiredChoicesDescription

Rendered component example

DataList
Owner
Jordan Doe
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>) => Themes.DataList.Root.view({}, [Themes.DataList.Item.view({}, [Themes.DataList.Label.view({}, ['Owner'], h), Themes.DataList.Value.view({}, ['Jordan Doe'], h)], h)], h)