@staffbase/widget-sdk 3.3.5 → 3.4.0-alpha.13

package/docs/SBColors.md

@@ -84,332 +84,556 @@ a foreground color on a white background.
 
 • **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)

package/docs/SBFileType.md

@@ -19,32 +19,56 @@ File type entity
 
 • **default**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:18](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L18)
+
 ___
 
 ### doc
 
 • **doc**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:21](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L21)
+
 ___
 
 ### img
 
 • **img**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:23](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L23)
+
 ___
 
 ### pdf
 
 • **pdf**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:22](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L22)
+
 ___
 
 ### ppt
 
 • **ppt**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:19](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L19)
+
 ___
 
 ### xls
 
 • **xls**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:20](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L20)

package/docs/SBImageEntity.md

@@ -19,32 +19,56 @@ Image entity definition
 
 • `Optional` **format**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:117](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L117)
+
 ___
 
 ### height
 
 • **height**: `number`
 
+#### Defined in
+
+[lib/widget-api-types.ts:118](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L118)
+
 ___
 
 ### mimeType
 
 • `Optional` **mimeType**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:119](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L119)
+
 ___
 
 ### size
 
 • `Optional` **size**: `number`
 
+#### Defined in
+
+[lib/widget-api-types.ts:120](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L120)
+
 ___
 
 ### url
 
 • **url**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:121](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L121)
+
 ___
 
 ### width
 
 • **width**: `number`
+
+#### Defined in
+
+[lib/widget-api-types.ts:122](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L122)

package/docs/SBUserAvatar.md

@@ -17,20 +17,36 @@ User avatar definition
 
 • **icon**: [`SBImageEntity`](../wiki/SBImageEntity)
 
+#### Defined in
+
+[lib/widget-api-types.ts:129](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L129)
+
 ___
 
 ### original
 
 • **original**: [`SBImageEntity`](../wiki/SBImageEntity)
 
+#### Defined in
+
+[lib/widget-api-types.ts:130](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L130)
+
 ___
 
 ### publicID
 
 • **publicID**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:131](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L131)
+
 ___
 
 ### thumb
 
 • **thumb**: [`SBImageEntity`](../wiki/SBImageEntity)
+
+#### Defined in
+
+[lib/widget-api-types.ts:132](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L132)