@staffbase/widget-sdk 3.3.4 → 3.3.5

package/docs/SBColors.md

@@ -0,0 +1,415 @@
+# 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`
+
+___
+
+### backgroundBase
+
+• **backgroundBase**: `string`
+
+___
+
+### backgroundField
+
+• **backgroundField**: `string`
+
+___
+
+### backgroundFieldLight
+
+• **backgroundFieldLight**: `string`
+
+___
+
+### backgroundLevel1
+
+• **backgroundLevel1**: `string`
+
+___
+
+### backgroundLevel2
+
+• **backgroundLevel2**: `string`
+
+___
+
+### backgroundLevel3
+
+• **backgroundLevel3**: `string`
+
+___
+
+### backgroundLevel4
+
+• **backgroundLevel4**: `string`
+
+___
+
+### backgroundPrimary
+
+• **backgroundPrimary**: `string`
+
+___
+
+### backgroundSecondary
+
+• **backgroundSecondary**: `string`
+
+___
+
+### backgroundTertiary
+
+• **backgroundTertiary**: `string`
+
+___
+
+### black
+
+• **black**: `string`
+
+___
+
+### blue
+
+• **blue**: `string`
+
+___
+
+### blueDark
+
+• **blueDark**: `string`
+
+___
+
+### blueLight
+
+• **blueLight**: `string`
+
+___
+
+### borderSolid
+
+• **borderSolid**: `string`
+
+___
+
+### borderTranslucent
+
+• **borderTranslucent**: `string`
+
+___
+
+### clientForeground
+
+• **clientForeground**: `string`
+
+___
+
+### clientPrimary
+
+• **clientPrimary**: `string`
+
+___
+
+### clientPrimaryA11y
+
+• **clientPrimaryA11y**: `string`
+
+___
+
+### clientSecondary
+
+• **clientSecondary**: `string`
+
+___
+
+### clientSecondaryA11y
+
+• **clientSecondaryA11y**: `string`
+
+___
+
+### fileType
+
+• **fileType**: [`SBFileType`](../wiki/SBFileType)
+
+___
+
+### green
+
+• **green**: `string`
+
+___
+
+### greenDark
+
+• **greenDark**: `string`
+
+___
+
+### greenLight
+
+• **greenLight**: `string`
+
+___
+
+### grey
+
+• **grey**: `string`
+
+___
+
+### greyDark
+
+• **greyDark**: `string`
+
+___
+
+### greyLight
+
+• **greyLight**: `string`
+
+___
+
+### hairline
+
+• **hairline**: `string`
+
+___
+
+### hairlineDark
+
+• **hairlineDark**: `string`
+
+___
+
+### hoverState
+
+• **hoverState**: `string`
+
+___
+
+### neutral
+
+• **neutral**: `string`
+
+___
+
+### neutralDark
+
+• **neutralDark**: `string`
+
+___
+
+### neutralLight
+
+• **neutralLight**: `string`
+
+___
+
+### orange
+
+• **orange**: `string`
+
+___
+
+### orangeDark
+
+• **orangeDark**: `string`
+
+___
+
+### orangeLight
+
+• **orangeLight**: `string`
+
+___
+
+### overlay
+
+• **overlay**: `string`
+
+___
+
+### overlayDark
+
+• **overlayDark**: `string`
+
+___
+
+### pressedState
+
+• **pressedState**: `string`
+
+___
+
+### red
+
+• **red**: `string`
+
+___
+
+### redDark
+
+• **redDark**: `string`
+
+___
+
+### redLight
+
+• **redLight**: `string`
+
+___
+
+### text
+
+• **text**: `string`
+
+___
+
+### textGreyBase
+
+• **textGreyBase**: `string`
+
+___
+
+### textGreyLevel1
+
+• **textGreyLevel1**: `string`
+
+___
+
+### textGreyLevel2
+
+• **textGreyLevel2**: `string`
+
+___
+
+### textGreyLevel3
+
+• **textGreyLevel3**: `string`
+
+___
+
+### textGreyLevel4
+
+• **textGreyLevel4**: `string`
+
+___
+
+### textLight
+
+• **textLight**: `string`
+
+___
+
+### textPlaceholder
+
+• **textPlaceholder**: `string`
+
+___
+
+### textPrimary
+
+• **textPrimary**: `string`
+
+___
+
+### textSecondary
+
+• **textSecondary**: `string`
+
+___
+
+### textTertiary
+
+• **textTertiary**: `string`
+
+___
+
+### warningYellow
+
+• **warningYellow**: `string`

package/docs/SBFileType.md

@@ -0,0 +1,50 @@
+# Interface: SBFileType
+
+File type entity
+
+## Table of contents
+
+### Properties
+
+- [default](../wiki/SBFileType#default)
+- [doc](../wiki/SBFileType#doc)
+- [img](../wiki/SBFileType#img)
+- [pdf](../wiki/SBFileType#pdf)
+- [ppt](../wiki/SBFileType#ppt)
+- [xls](../wiki/SBFileType#xls)
+
+## Properties
+
+### default
+
+• **default**: `string`
+
+___
+
+### doc
+
+• **doc**: `string`
+
+___
+
+### img
+
+• **img**: `string`
+
+___
+
+### pdf
+
+• **pdf**: `string`
+
+___
+
+### ppt
+
+• **ppt**: `string`
+
+___
+
+### xls
+
+• **xls**: `string`

package/docs/SBImageEntity.md

@@ -0,0 +1,50 @@
+# Interface: SBImageEntity
+
+Image entity definition
+
+## Table of contents
+
+### Properties
+
+- [format](../wiki/SBImageEntity#format)
+- [height](../wiki/SBImageEntity#height)
+- [mimeType](../wiki/SBImageEntity#mimetype)
+- [size](../wiki/SBImageEntity#size)
+- [url](../wiki/SBImageEntity#url)
+- [width](../wiki/SBImageEntity#width)
+
+## Properties
+
+### format
+
+• `Optional` **format**: `string`
+
+___
+
+### height
+
+• **height**: `number`
+
+___
+
+### mimeType
+
+• `Optional` **mimeType**: `string`
+
+___
+
+### size
+
+• `Optional` **size**: `number`
+
+___
+
+### url
+
+• **url**: `string`
+
+___
+
+### width
+
+• **width**: `number`

package/docs/SBUserAvatar.md

@@ -0,0 +1,36 @@
+# Interface: SBUserAvatar
+
+User avatar definition
+
+## Table of contents
+
+### Properties
+
+- [icon](../wiki/SBUserAvatar#icon)
+- [original](../wiki/SBUserAvatar#original)
+- [publicID](../wiki/SBUserAvatar#publicid)
+- [thumb](../wiki/SBUserAvatar#thumb)
+
+## Properties
+
+### icon
+
+• **icon**: [`SBImageEntity`](../wiki/SBImageEntity)
+
+___
+
+### original
+
+• **original**: [`SBImageEntity`](../wiki/SBImageEntity)
+
+___
+
+### publicID
+
+• **publicID**: `string`
+
+___
+
+### thumb
+
+• **thumb**: [`SBImageEntity`](../wiki/SBImageEntity)

package/docs/SBUserProfile.md

@@ -0,0 +1,64 @@
+# Interface: SBUserProfile
+
+User profile data
+
+## Table of contents
+
+### Properties
+
+- [avatar](../wiki/SBUserProfile#avatar)
+- [department](../wiki/SBUserProfile#department)
+- [firstName](../wiki/SBUserProfile#firstname)
+- [lastName](../wiki/SBUserProfile#lastname)
+- [location](../wiki/SBUserProfile#location)
+- [phoneNumber](../wiki/SBUserProfile#phonenumber)
+- [position](../wiki/SBUserProfile#position)
+- [publicEmailAddress](../wiki/SBUserProfile#publicemailaddress)
+
+## Properties
+
+### avatar
+
+• `Optional` **avatar**: [`SBUserAvatar`](../wiki/SBUserAvatar)
+
+___
+
+### department
+
+• `Optional` **department**: `string`
+
+___
+
+### firstName
+
+• **firstName**: `string`
+
+___
+
+### lastName
+
+• **lastName**: `string`
+
+___
+
+### location
+
+• `Optional` **location**: `string`
+
+___
+
+### phoneNumber
+
+• `Optional` **phoneNumber**: `string`
+
+___
+
+### position
+
+• `Optional` **position**: `string`
+
+___
+
+### publicEmailAddress
+
+• `Optional` **publicEmailAddress**: `string`

package/docs/UserListItem.md

@@ -0,0 +1,36 @@
+# Interface: UserListItem
+
+Single user item
+
+## Table of contents
+
+### Properties
+
+- [entityType](../wiki/UserListItem#entitytype)
+- [firstName](../wiki/UserListItem#firstname)
+- [id](../wiki/UserListItem#id)
+- [lastName](../wiki/UserListItem#lastname)
+
+## Properties
+
+### entityType
+
+• `Optional` **entityType**: `string`
+
+___
+
+### firstName
+
+• `Optional` **firstName**: `string`
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+___
+
+### lastName
+
+• `Optional` **lastName**: `string`

package/docs/UserListRequestQuery.md

@@ -0,0 +1,36 @@
+# Interface: UserListRequestQuery
+
+User list request parameters
+
+## Table of contents
+
+### Properties
+
+- [filter](../wiki/UserListRequestQuery#filter)
+- [limit](../wiki/UserListRequestQuery#limit)
+- [offset](../wiki/UserListRequestQuery#offset)
+- [sort](../wiki/UserListRequestQuery#sort)
+
+## Properties
+
+### filter
+
+• `Optional` **filter**: `string`
+
+___
+
+### limit
+
+• `Optional` **limit**: `number`
+
+___
+
+### offset
+
+• `Optional` **offset**: `number`
+
+___
+
+### sort
+
+• `Optional` **sort**: [`UserListSorting`](../wiki/Home#userlistsorting)

package/docs/UserListResponse.md

@@ -0,0 +1,36 @@
+# Interface: UserListResponse
+
+Responded user list
+
+## Table of contents
+
+### Properties
+
+- [data](../wiki/UserListResponse#data)
+- [limit](../wiki/UserListResponse#limit)
+- [offset](../wiki/UserListResponse#offset)
+- [total](../wiki/UserListResponse#total)
+
+## Properties
+
+### data
+
+• **data**: [`UserListItem`](../wiki/UserListItem)[]
+
+___
+
+### limit
+
+• **limit**: `number`
+
+___
+
+### offset
+
+• **offset**: `number`
+
+___
+
+### total
+
+• **total**: `number`