@staffbase/widget-sdk 3.3.3-beta.2 → 3.4.0-alpha.13

package/docs/IntegrationToken.md

@@ -0,0 +1,30 @@
+# Interface: IntegrationToken
+
+Integration Token including the expiration time
+
+## Table of contents
+
+### Properties
+
+- [accessToken](../wiki/IntegrationToken#accesstoken)
+- [accessTokenExpiresAt](../wiki/IntegrationToken#accesstokenexpiresat)
+
+## Properties
+
+### accessToken
+
+• **accessToken**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:196](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L196)
+
+___
+
+### accessTokenExpiresAt
+
+• `Optional` **accessTokenExpiresAt**: `Date`
+
+#### Defined in
+
+[lib/widget-api-types.ts:199](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L199)

package/docs/SBColors.md

@@ -0,0 +1,639 @@
+# Interface: SBColors
+
+Detailed colors entity definition
+
+**`param`** This color is meant to be used for foreground elements and is either black or white depending
+on which gives the better contrast when used as a foreground color for [clientPrimary](../wiki/SBColors#clientprimary)
+
+**`param`** The customer's primary color (previously `bgColor`)
+
+**`param`** This is [clientPrimary](../wiki/SBColors#clientprimary) adjusted in contrast to give a good contrast when used as a
+foreground color on a white background.
+
+**`param`** The customer's secondary color (previously `textColor`).
+
+**`param`** This is [clientSecondary](../wiki/SBColors#clientsecondary) adjusted in contrast to give a good contrast when used as
+a foreground color on a white background.
+
+**`param`** Active action component states for components with white background: Hover, Pressed, etc...
+
+## Table of contents
+
+### Properties
+
+- [backdrop](../wiki/SBColors#backdrop)
+- [backgroundBase](../wiki/SBColors#backgroundbase)
+- [backgroundField](../wiki/SBColors#backgroundfield)
+- [backgroundFieldLight](../wiki/SBColors#backgroundfieldlight)
+- [backgroundLevel1](../wiki/SBColors#backgroundlevel1)
+- [backgroundLevel2](../wiki/SBColors#backgroundlevel2)
+- [backgroundLevel3](../wiki/SBColors#backgroundlevel3)
+- [backgroundLevel4](../wiki/SBColors#backgroundlevel4)
+- [backgroundPrimary](../wiki/SBColors#backgroundprimary)
+- [backgroundSecondary](../wiki/SBColors#backgroundsecondary)
+- [backgroundTertiary](../wiki/SBColors#backgroundtertiary)
+- [black](../wiki/SBColors#black)
+- [blue](../wiki/SBColors#blue)
+- [blueDark](../wiki/SBColors#bluedark)
+- [blueLight](../wiki/SBColors#bluelight)
+- [borderSolid](../wiki/SBColors#bordersolid)
+- [borderTranslucent](../wiki/SBColors#bordertranslucent)
+- [clientForeground](../wiki/SBColors#clientforeground)
+- [clientPrimary](../wiki/SBColors#clientprimary)
+- [clientPrimaryA11y](../wiki/SBColors#clientprimarya11y)
+- [clientSecondary](../wiki/SBColors#clientsecondary)
+- [clientSecondaryA11y](../wiki/SBColors#clientsecondarya11y)
+- [fileType](../wiki/SBColors#filetype)
+- [green](../wiki/SBColors#green)
+- [greenDark](../wiki/SBColors#greendark)
+- [greenLight](../wiki/SBColors#greenlight)
+- [grey](../wiki/SBColors#grey)
+- [greyDark](../wiki/SBColors#greydark)
+- [greyLight](../wiki/SBColors#greylight)
+- [hairline](../wiki/SBColors#hairline)
+- [hairlineDark](../wiki/SBColors#hairlinedark)
+- [hoverState](../wiki/SBColors#hoverstate)
+- [neutral](../wiki/SBColors#neutral)
+- [neutralDark](../wiki/SBColors#neutraldark)
+- [neutralLight](../wiki/SBColors#neutrallight)
+- [orange](../wiki/SBColors#orange)
+- [orangeDark](../wiki/SBColors#orangedark)
+- [orangeLight](../wiki/SBColors#orangelight)
+- [overlay](../wiki/SBColors#overlay)
+- [overlayDark](../wiki/SBColors#overlaydark)
+- [pressedState](../wiki/SBColors#pressedstate)
+- [red](../wiki/SBColors#red)
+- [redDark](../wiki/SBColors#reddark)
+- [redLight](../wiki/SBColors#redlight)
+- [text](../wiki/SBColors#text)
+- [textGreyBase](../wiki/SBColors#textgreybase)
+- [textGreyLevel1](../wiki/SBColors#textgreylevel1)
+- [textGreyLevel2](../wiki/SBColors#textgreylevel2)
+- [textGreyLevel3](../wiki/SBColors#textgreylevel3)
+- [textGreyLevel4](../wiki/SBColors#textgreylevel4)
+- [textLight](../wiki/SBColors#textlight)
+- [textPlaceholder](../wiki/SBColors#textplaceholder)
+- [textPrimary](../wiki/SBColors#textprimary)
+- [textSecondary](../wiki/SBColors#textsecondary)
+- [textTertiary](../wiki/SBColors#texttertiary)
+- [warningYellow](../wiki/SBColors#warningyellow)
+
+## Properties
+
+### backdrop
+
+• **backdrop**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:41](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L41)
+
+___
+
+### backgroundBase
+
+• **backgroundBase**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:61](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L61)
+
+___
+
+### backgroundField
+
+• **backgroundField**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:42](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L42)
+
+___
+
+### backgroundFieldLight
+
+• **backgroundFieldLight**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:43](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L43)
+
+___
+
+### backgroundLevel1
+
+• **backgroundLevel1**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:62](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L62)
+
+___
+
+### backgroundLevel2
+
+• **backgroundLevel2**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:63](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L63)
+
+___
+
+### backgroundLevel3
+
+• **backgroundLevel3**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:64](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L64)
+
+___
+
+### backgroundLevel4
+
+• **backgroundLevel4**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:65](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L65)
+
+___
+
+### backgroundPrimary
+
+• **backgroundPrimary**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:44](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L44)
+
+___
+
+### backgroundSecondary
+
+• **backgroundSecondary**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:45](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L45)
+
+___
+
+### backgroundTertiary
+
+• **backgroundTertiary**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:46](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L46)
+
+___
+
+### black
+
+• **black**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:47](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L47)
+
+___
+
+### blue
+
+• **blue**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:66](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L66)
+
+___
+
+### blueDark
+
+• **blueDark**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:67](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L67)
+
+___
+
+### blueLight
+
+• **blueLight**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:68](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L68)
+
+___
+
+### borderSolid
+
+• **borderSolid**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:48](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L48)
+
+___
+
+### borderTranslucent
+
+• **borderTranslucent**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:49](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L49)
+
+___
+
+### clientForeground
+
+• **clientForeground**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:50](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L50)
+
+___
+
+### clientPrimary
+
+• **clientPrimary**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:51](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L51)
+
+___
+
+### clientPrimaryA11y
+
+• **clientPrimaryA11y**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:52](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L52)
+
+___
+
+### clientSecondary
+
+• **clientSecondary**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:53](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L53)
+
+___
+
+### clientSecondaryA11y
+
+• **clientSecondaryA11y**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:54](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L54)
+
+___
+
+### fileType
+
+• **fileType**: [`SBFileType`](../wiki/SBFileType)
+
+#### Defined in
+
+[lib/widget-api-types.ts:40](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L40)
+
+___
+
+### green
+
+• **green**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:69](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L69)
+
+___
+
+### greenDark
+
+• **greenDark**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:70](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L70)
+
+___
+
+### greenLight
+
+• **greenLight**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:71](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L71)
+
+___
+
+### grey
+
+• **grey**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:72](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L72)
+
+___
+
+### greyDark
+
+• **greyDark**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:73](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L73)
+
+___
+
+### greyLight
+
+• **greyLight**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:74](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L74)
+
+___
+
+### hairline
+
+• **hairline**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:75](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L75)
+
+___
+
+### hairlineDark
+
+• **hairlineDark**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:76](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L76)
+
+___
+
+### hoverState
+
+• **hoverState**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:60](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L60)
+
+___
+
+### neutral
+
+• **neutral**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:77](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L77)
+
+___
+
+### neutralDark
+
+• **neutralDark**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:78](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L78)
+
+___
+
+### neutralLight
+
+• **neutralLight**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:79](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L79)
+
+___
+
+### orange
+
+• **orange**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:80](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L80)
+
+___
+
+### orangeDark
+
+• **orangeDark**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:81](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L81)
+
+___
+
+### orangeLight
+
+• **orangeLight**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:82](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L82)
+
+___
+
+### overlay
+
+• **overlay**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:83](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L83)
+
+___
+
+### overlayDark
+
+• **overlayDark**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:84](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L84)
+
+___
+
+### pressedState
+
+• **pressedState**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:59](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L59)
+
+___
+
+### red
+
+• **red**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:85](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L85)
+
+___
+
+### redDark
+
+• **redDark**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:86](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L86)
+
+___
+
+### redLight
+
+• **redLight**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:87](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L87)
+
+___
+
+### text
+
+• **text**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:88](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L88)
+
+___
+
+### textGreyBase
+
+• **textGreyBase**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:89](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L89)
+
+___
+
+### textGreyLevel1
+
+• **textGreyLevel1**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:90](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L90)
+
+___
+
+### textGreyLevel2
+
+• **textGreyLevel2**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:91](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L91)
+
+___
+
+### textGreyLevel3
+
+• **textGreyLevel3**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:92](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L92)
+
+___
+
+### textGreyLevel4
+
+• **textGreyLevel4**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:93](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L93)
+
+___
+
+### textLight
+
+• **textLight**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:94](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L94)
+
+___
+
+### textPlaceholder
+
+• **textPlaceholder**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:55](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L55)
+
+___
+
+### textPrimary
+
+• **textPrimary**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:56](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L56)
+
+___
+
+### textSecondary
+
+• **textSecondary**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:57](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L57)
+
+___
+
+### textTertiary
+
+• **textTertiary**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:58](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L58)
+
+___
+
+### warningYellow
+
+• **warningYellow**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:95](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L95)