ui/dist¶

Type Aliases¶

AppearanceConfiguration¶

type AppearanceConfiguration = {
  elements?: Partial<Record<ElementKey | WidgetElementKey, AppearanceElementValue>>;
  variables?: Record<string, string>;
  widgets?: Record<string, {
     elements?: Partial<Record<WidgetElementKey, AppearanceElementValue>>;
  }>;
};

Properties¶

elements?¶

optional elements?: Partial<Record<ElementKey | WidgetElementKey, AppearanceElementValue>>;

variables?¶

optional variables?: Record<string, string>;

widgets?¶

optional widgets?: Record<string, {
  elements?: Partial<Record<WidgetElementKey, AppearanceElementValue>>;
}>;

AppearanceElementObject¶

type AppearanceElementObject = {
  className?: string;
  style?: AppearanceStyle;
};

Properties¶

className?¶

optional className?: string;

style?¶

optional style?: AppearanceStyle;

AppearanceElementValue¶

type AppearanceElementValue =
  | string
  | AppearanceStyle
  | AppearanceElementObject;

AppearanceStyle¶

type AppearanceStyle = Record<string, string | number>;

ElementKey¶

type ElementKey = keyof typeof elementKeys;

WidgetElementKey¶

type WidgetElementKey = keyof typeof widgetElementKeys;

Variables¶

elementKeys¶

const elementKeys: {
  activityDot: "activityDot";
  activityIndicator: "activityIndicator";
  composer: "composer";
  composerInput: "composerInput";
  composerSendButton: "composerSendButton";
  error: "error";
  header: "header";
  messageAssistant: "messageAssistant";
  messageList: "messageList";
  messageSourceLink: "messageSourceLink";
  messageSources: "messageSources";
  messageSourceSegment: "messageSourceSegment";
  messageUser: "messageUser";
  root: "root";
  widgetContainer: "widgetContainer";
  widgetOutlet: "widgetOutlet";
};

Type Declaration¶

Name	Type
`activityDot`	`"activityDot"`
`activityIndicator`	`"activityIndicator"`
`composer`	`"composer"`
`composerInput`	`"composerInput"`
`composerSendButton`	`"composerSendButton"`
`error`	`"error"`
`header`	`"header"`
`messageAssistant`	`"messageAssistant"`
`messageList`	`"messageList"`
`messageSourceLink`	`"messageSourceLink"`
`messageSources`	`"messageSources"`
`messageSourceSegment`	`"messageSourceSegment"`
`messageUser`	`"messageUser"`
`root`	`"root"`
`widgetContainer`	`"widgetContainer"`
`widgetOutlet`	`"widgetOutlet"`

widgetElementKeys¶

const widgetElementKeys: {
  actions: "actions";
  button: "button";
  choice: "choice";
  choiceDescription: "choiceDescription";
  choiceLabel: "choiceLabel";
  choiceList: "choiceList";
  description: "description";
  field: "field";
  fieldLabel: "fieldLabel";
  fields: "fields";
  input: "input";
  panel: "panel";
  primaryButton: "primaryButton";
  title: "title";
};

Type Declaration¶

Name	Type
`actions`	`"actions"`
`button`	`"button"`
`choice`	`"choice"`
`choiceDescription`	`"choiceDescription"`
`choiceLabel`	`"choiceLabel"`
`choiceList`	`"choiceList"`
`description`	`"description"`
`field`	`"field"`
`fieldLabel`	`"fieldLabel"`
`fields`	`"fields"`
`input`	`"input"`
`panel`	`"panel"`
`primaryButton`	`"primaryButton"`
`title`	`"title"`

Functions¶

resolveElementClassName()¶

function resolveElementClassName(key, appearance?): string;

Parameters¶

Parameter	Type
`key`	\| `"error"` \| `"root"` \| `"header"` \| `"messageList"` \| `"messageAssistant"` \| `"messageSourceSegment"` \| `"messageUser"` \| `"messageSources"` \| `"messageSourceLink"` \| `"activityIndicator"` \| `"activityDot"` \| `"composer"` \| `"composerInput"` \| `"composerSendButton"` \| `"widgetOutlet"` \| `"widgetContainer"`
`appearance?`	`AppearanceConfiguration`

Returns¶

string

resolveInlineStyle()¶

function resolveInlineStyle(key, appearance?): AppearanceStyle;

Parameters¶

Parameter	Type
`key`	\| `"error"` \| `"root"` \| `"header"` \| `"messageList"` \| `"messageAssistant"` \| `"messageSourceSegment"` \| `"messageUser"` \| `"messageSources"` \| `"messageSourceLink"` \| `"activityIndicator"` \| `"activityDot"` \| `"composer"` \| `"composerInput"` \| `"composerSendButton"` \| `"widgetOutlet"` \| `"widgetContainer"`
`appearance?`	`AppearanceConfiguration`

Returns¶

AppearanceStyle

resolveWidgetElementClassName()¶

function resolveWidgetElementClassName(
   widgetKind,
   key,
   appearance?): string;

Parameters¶

Parameter	Type
`widgetKind`	`string`
`key`	\| `"input"` \| `"description"` \| `"choice"` \| `"title"` \| `"fields"` \| `"panel"` \| `"actions"` \| `"button"` \| `"primaryButton"` \| `"choiceList"` \| `"choiceLabel"` \| `"choiceDescription"` \| `"field"` \| `"fieldLabel"`
`appearance?`	`AppearanceConfiguration`

Returns¶

string

resolveWidgetInlineStyle()¶

function resolveWidgetInlineStyle(
   widgetKind,
   key,
   appearance?): AppearanceStyle;

Parameters¶

Parameter	Type
`widgetKind`	`string`
`key`	\| `"input"` \| `"description"` \| `"choice"` \| `"title"` \| `"fields"` \| `"panel"` \| `"actions"` \| `"button"` \| `"primaryButton"` \| `"choiceList"` \| `"choiceLabel"` \| `"choiceDescription"` \| `"field"` \| `"fieldLabel"`
`appearance?`	`AppearanceConfiguration`

Returns¶

AppearanceStyle