@staffbase/widget-sdk 3.4.0-beta.2 → 3.4.0-beta.6

package/docs/Interface: BlockAttributes.md

@@ -1,11 +0,0 @@
-# Interface: BlockAttributes
-
-## Indexable
-
-▪ [key: *string*]: *number* \| *boolean* \| *string*
-
-## Properties
-
-### contentLanguage
-
-• **contentLanguage**: *string*

package/docs/Interface: BlockDefinition.md

@@ -1,117 +0,0 @@
-# Interface: BlockDefinition<Factory\>
-
-## Type parameters
-
-| Name | Default |
-| :------ | :------ |
-| `Factory` | [*BlockFactory*](../wiki/Home#blockfactory) |
-
-## Properties
-
-### attributes
-
-• **attributes**: *string*[]
-
-DOM attributes of the element, must be in kebab-case.
-
-___
-
-### blockLevel
-
-• `Optional` **blockLevel**: ``"block"`` \| ``"inline"``
-
-Set to `inline` if you want the element to behave like a span element
-rather than a div element if not specified, it defaults to `block`.
-
-___
-
-### configurationSchema
-
-• **configurationSchema**: JSONSchema7
-
-Schema used for defining the configuration form.
-
-**`example`** 
-```json
-{
- "type": "object",
- "required": [
-   "firstName",
-   "lastName"
-   ],
- "properties": {
-   "firstName": {
-     "type": "string",
-     "title": "First name"
-     },
- "lastName": {
-   "type": "string",
-   "title": "Last name"
-   }
- }
-}
-```
-
-**`see`** https://react-jsonschema-form.readthedocs.io/en/latest/
-
-___
-
-### factory
-
-• **factory**: Factory
-
-The implementation of the web component.
-
-___
-
-### iconUrl
-
-• `Optional` **iconUrl**: *string*
-
-Icon displayed on the widget installation page.
-We recommend an icon with the dimensions 32x32 px.
-
-___
-
-### label
-
-• `Optional` **label**: *string*
-
-Label displayed in the settings dialog and in the default widget preview.
-
-___
-
-### name
-
-• **name**: *string*
-
-The tag name of the widget. It must be compatible with
-webcomponent naming conventions.
-
-**`see`** https://www.webcomponents.org/community/articles/how-should-i-name-my-element
-
-___
-
-### options
-
-• `Optional` **options**: ElementDefinitionOptions
-
-Can be used for extending from a built-in element.
-
-___
-
-### uiSchema
-
-• `Optional` **uiSchema**: UiSchema
-
-Schema to add more customization to the look and feel of the configuration form.
-
-```json
-{
-  "firstName": {
-     "ui:help": "Your first name."
-  }
-}
-```
-
-**`see`** https://react-jsonschema-form.readthedocs.io/en/latest/api-reference/uiSchema/

package/docs/Interface: BlockElement.md

@@ -1,89 +0,0 @@
-# Interface: BlockElement
-
-## Properties
-
-### adoptedCallback
-
-• **adoptedCallback**: () => *void*
-
-Invoked when the custom element is moved to a new document.
-
-#### Type declaration:
-
-▸ (): *void*
-
-**Returns:** *void*
-
-___
-
-### attributeChangedCallback
-
-• **attributeChangedCallback**: (`attrName`: *string*, `oldValue`: *undefined* \| *string*, `newValue`: *undefined* \| *string*) => *void*
-
-Invoked when one of the attributes of the custom element is added, removed, or changed.
-
-Note that you have to statically register the observed values with the 'observedAttributes' static getter.
-
-**`param`** The changed attributes name
-
-**`param`** The old value
-
-**`param`** The new value
-
-#### Type declaration:
-
-▸ (`attrName`: *string*, `oldValue`: *undefined* \| *string*, `newValue`: *undefined* \| *string*): *void*
-
-#### Parameters:
-
-| Name | Type |
-| :------ | :------ |
-| `attrName` | *string* |
-| `oldValue` | *undefined* \| *string* |
-| `newValue` | *undefined* \| *string* |
-
-**Returns:** *void*
-
-___
-
-### connectedCallback
-
-• **connectedCallback**: () => *void*
-
-Invoked when the custom element is first connected to the DOM.
-
-#### Type declaration:
-
-▸ (): *void*
-
-**Returns:** *void*
-
-___
-
-### disconnectedCallback
-
-• **disconnectedCallback**: () => *void*
-
-Invoked when the custom element is disconnected from the DOM.
-
-#### Type declaration:
-
-▸ (): *void*
-
-**Returns:** *void*
-
-___
-
-### unmount
-
-• **unmount**: () => *void*
-
-Method to unmount / revert any effects applied by rendering.
-E.g. to be used in editor cases to remove any rendered content
-and revert the block to its initial state.
-
-#### Type declaration:
-
-▸ (): *void*
-
-**Returns:** *void*

package/docs/Interface: ColorTheme.md

@@ -1,52 +0,0 @@
-# Interface: ColorTheme
-
-The color theme allows the widget to mimic the look
-and feel of the Staffbase ecosystem it was added to.
-
-## Properties
-
-### bgColor
-
-• **bgColor**: *string*
-
-___
-
-### bgColorDarkened1
-
-• `Optional` **bgColorDarkened1**: *string*
-
-___
-
-### bgColorDarkened2
-
-• `Optional` **bgColorDarkened2**: *string*
-
-___
-
-### bgColorDarkened2Opaque
-
-• `Optional` **bgColorDarkened2Opaque**: *string*
-
-___
-
-### bgColorLum
-
-• `Optional` **bgColorLum**: *string*
-
-___
-
-### colors
-
-• **colors**: [*SBColors*](../wiki/Interface:%20SBColors)
-
-___
-
-### outlineColor
-
-• `Optional` **outlineColor**: *string*
-
-___
-
-### textColor
-
-• **textColor**: *string*

package/docs/Interface: ExternalBlockDefinition.md

@@ -1,38 +0,0 @@
-# Interface: ExternalBlockDefinition<Factory\>
-
-Defintion of the Widget.
-
-Includes the implementation of the BlockDefinition
-and meta information (author and version of the widget).
-
-## Type parameters
-
-| Name | Default |
-| :------ | :------ |
-| `Factory` | [*BlockFactory*](../wiki/Home#blockfactory) |
-
-## Properties
-
-### author
-
-• **author**: *string*
-
-Name of the author.
-
-___
-
-### blockDefinition
-
-• **blockDefinition**: [*BlockDefinition*](../wiki/Interface:%20BlockDefinition)<Factory\>
-
-Definition of the block.
-
-Will be registered to the staffbase app.
-
-___
-
-### version
-
-• **version**: *string*
-
-Current version of the widget.

package/docs/Interface: SBColors.md

@@ -1,354 +0,0 @@
-# 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/Interface:%20SBColors#clientprimary)
-
-**`param`** The customer's primary color (previously `bgColor`)
-
-**`param`** This is [clientPrimary](../wiki/Interface:%20SBColors#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/Interface:%20SBColors#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...
-
-## 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/Interface:%20SBFileType)
-
-___
-
-### 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/Interface: SBFileType.md

@@ -1,39 +0,0 @@
-# Interface: SBFileType
-
-File type entity
-
-## Properties
-
-### default
-
-• **default**: *string*
-
-___
-
-### doc
-
-• **doc**: *string*
-
-___
-
-### img
-
-• **img**: *string*
-
-___
-
-### pdf
-
-• **pdf**: *string*
-
-___
-
-### ppt
-
-• **ppt**: *string*
-
-___
-
-### xls
-
-• **xls**: *string*

package/docs/Interface: SBImageEntity.md

@@ -1,39 +0,0 @@
-# Interface: SBImageEntity
-
-Image entity definition
-
-## Properties
-
-### format
-
-• `Optional` **format**: *string*
-
-___
-
-### height
-
-• **height**: *number*
-
-___
-
-### mimeType
-
-• `Optional` **mimeType**: *string*
-
-___
-
-### size
-
-• `Optional` **size**: *number*
-
-___
-
-### url
-
-• **url**: *string*
-
-___
-
-### width
-
-• **width**: *number*