Documentation navigation

Published API · 0.1.0-rc.1

themes · components/callout

Published themes API declarations for components/callout.

./components/callout

@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/callout'

Exported declarations

Icon

Icon: Readonly<{
    Props: Schema.Struct<{}>;
    view: typeof iconView;
}>

IconProps

export type IconProps = typeof iconProps.Type;

Root

Root: Readonly<{
    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 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 variant: Schema.optional<Schema.Literals<readonly ["soft", "surface", "outline"]>>;
        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: typeof rootView;
}>

RootProps

export type RootProps = typeof rootProps.Type;

Text

Text: Readonly<{
    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 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 weight: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        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>;
        }>]>>;
        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>;
        }>]>>;
        readonly wrap: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
            [k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
        }>]>>;
        readonly truncate: Schema.optional<Schema.Boolean>;
        readonly highContrast: Schema.optional<Schema.Boolean>;
        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"]>>;
    }>;
    view: typeof textView;
}>

TextProps

export type TextProps = typeof textProps.Type;

Icon.Props

Props exported by @wsagency/wseffect-themes/components/callout · Icon.Props · source
NameTypeRequiredChoicesDescription

Root.Props

Props exported by @wsagency/wseffect-themes/components/callout · Root.Props · source
NameTypeRequiredChoicesDescription
size"1" | "2" | "3" | Responsive<"1" | "2" | "3">No——
variant"soft" | "surface" | "outline"No"soft", "surface", "outline"—
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——
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——

Text.Props

Props exported by @wsagency/wseffect-themes/components/callout · Text.Props · source
NameTypeRequiredChoicesDescription
size"1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | Responsive<"1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9">No——
weight"light" | "regular" | "medium" | "bold" | Responsive<"light" | "regular" | "medium" | "bold">No——
align"left" | "center" | "right" | Responsive<"left" | "center" | "right">No——
trim"normal" | "start" | "end" | "both" | Responsive<"normal" | "start" | "end" | "both">No——
wrap"wrap" | "nowrap" | "pretty" | "balance" | Responsive<"wrap" | "nowrap" | "pretty" | "balance">No——
truncatebooleanNo——
highContrastbooleanNo——
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"—
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——

Rendered component example

Callout

A deployment is ready.

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.Callout.Root.view({ color: 'blue', variant: 'soft' }, [Themes.Callout.Text.view({}, ['A deployment is ready.'], h)], h)