@staffbase/widget-sdk 3.3.4 → 3.3.5

package/docs/BlockAttributes.md

@@ -0,0 +1,17 @@
+# Interface: BlockAttributes
+
+## Indexable
+
+▪ [key: `string`]: `number` \| `boolean` \| `string`
+
+## Table of contents
+
+### Properties
+
+- [contentLanguage](../wiki/BlockAttributes#contentlanguage)
+
+## Properties
+
+### contentLanguage
+
+• **contentLanguage**: `string`

package/docs/{Interface: BlockDefinition.md → BlockDefinition.md}

@@ -2,15 +2,29 @@
 
 ## Type parameters
 
-| Name | Default |
+| Name | Type |
 | :------ | :------ |
-| `Factory` | [*BlockFactory*](../wiki/Home#blockfactory) |
+| `Factory` | [`BlockFactory`](../wiki/Home#blockfactory) |
+
+## Table of contents
+
+### Properties
+
+- [attributes](../wiki/BlockDefinition#attributes)
+- [blockLevel](../wiki/BlockDefinition#blocklevel)
+- [configurationSchema](../wiki/BlockDefinition#configurationschema)
+- [factory](../wiki/BlockDefinition#factory)
+- [iconUrl](../wiki/BlockDefinition#iconurl)
+- [label](../wiki/BlockDefinition#label)
+- [name](../wiki/BlockDefinition#name)
+- [options](../wiki/BlockDefinition#options)
+- [uiSchema](../wiki/BlockDefinition#uischema)
 
 ## Properties
 
 ### attributes
 
-• **attributes**: *string*[]
+• **attributes**: `string`[]
 
 DOM attributes of the element, must be in kebab-case.
 
@@ -27,11 +41,11 @@ ___
 
 ### configurationSchema
 
-• **configurationSchema**: JSONSchema7
+• **configurationSchema**: `JSONSchema7`
 
 Schema used for defining the configuration form.
 
-**`example`** 
+**`example`**
 ```json
 {
  "type": "object",
@@ -58,7 +72,7 @@ ___
 
 ### factory
 
-• **factory**: Factory
+• **factory**: `Factory`
 
 The implementation of the web component.
 
@@ -66,7 +80,7 @@ ___
 
 ### iconUrl
 
-• `Optional` **iconUrl**: *string*
+• `Optional` **iconUrl**: `string`
 
 Icon displayed on the widget installation page.
 We recommend an icon with the dimensions 32x32 px.
@@ -75,7 +89,7 @@ ___
 
 ### label
 
-• `Optional` **label**: *string*
+• `Optional` **label**: `string`
 
 Label displayed in the settings dialog and in the default widget preview.
 
@@ -83,7 +97,7 @@ ___
 
 ### name
 
-• **name**: *string*
+• **name**: `string`
 
 The tag name of the widget. It must be compatible with
 webcomponent naming conventions.
@@ -94,7 +108,7 @@ ___
 
 ### options
 
-• `Optional` **options**: ElementDefinitionOptions
+• `Optional` **options**: `ElementDefinitionOptions`
 
 Can be used for extending from a built-in element.
 
@@ -102,7 +116,7 @@ ___
 
 ### uiSchema
 
-• `Optional` **uiSchema**: UiSchema
+• `Optional` **uiSchema**: `UiSchema`
 
 Schema to add more customization to the look and feel of the configuration form.
 

package/docs/BlockElement.md

@@ -0,0 +1,83 @@
+# Interface: BlockElement
+
+## Table of contents
+
+### Methods
+
+- [adoptedCallback](../wiki/BlockElement#adoptedcallback)
+- [attributeChangedCallback](../wiki/BlockElement#attributechangedcallback)
+- [connectedCallback](../wiki/BlockElement#connectedcallback)
+- [disconnectedCallback](../wiki/BlockElement#disconnectedcallback)
+- [unmount](../wiki/BlockElement#unmount)
+
+## Methods
+
+### adoptedCallback
+
+▸ **adoptedCallback**(): `void`
+
+Invoked when the custom element is moved to a new document.
+
+#### Returns
+
+`void`
+
+___
+
+### attributeChangedCallback
+
+▸ **attributeChangedCallback**(`attrName`, `oldValue`, `newValue`): `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.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `attrName` | `string` | The changed attributes name |
+| `oldValue` | `undefined` \| `string` | The old value |
+| `newValue` | `undefined` \| `string` | The new value |
+
+#### Returns
+
+`void`
+
+___
+
+### connectedCallback
+
+▸ **connectedCallback**(): `void`
+
+Invoked when the custom element is first connected to the DOM.
+
+#### Returns
+
+`void`
+
+___
+
+### disconnectedCallback
+
+▸ **disconnectedCallback**(): `void`
+
+Invoked when the custom element is disconnected from the DOM.
+
+#### 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.
+
+#### Returns
+
+`void`

package/docs/ColorTheme.md

@@ -0,0 +1,65 @@
+# Interface: ColorTheme
+
+The color theme allows the widget to mimic the look
+and feel of the Staffbase ecosystem it was added to.
+
+## Table of contents
+
+### Properties
+
+- [bgColor](../wiki/ColorTheme#bgcolor)
+- [bgColorDarkened1](../wiki/ColorTheme#bgcolordarkened1)
+- [bgColorDarkened2](../wiki/ColorTheme#bgcolordarkened2)
+- [bgColorDarkened2Opaque](../wiki/ColorTheme#bgcolordarkened2opaque)
+- [bgColorLum](../wiki/ColorTheme#bgcolorlum)
+- [colors](../wiki/ColorTheme#colors)
+- [outlineColor](../wiki/ColorTheme#outlinecolor)
+- [textColor](../wiki/ColorTheme#textcolor)
+
+## Properties
+
+### bgColor
+
+• **bgColor**: `string`
+
+___
+
+### bgColorDarkened1
+
+• `Optional` **bgColorDarkened1**: `string`
+
+___
+
+### bgColorDarkened2
+
+• `Optional` **bgColorDarkened2**: `string`
+
+___
+
+### bgColorDarkened2Opaque
+
+• `Optional` **bgColorDarkened2Opaque**: `string`
+
+___
+
+### bgColorLum
+
+• `Optional` **bgColorLum**: `string`
+
+___
+
+### colors
+
+• **colors**: [`SBColors`](../wiki/SBColors)
+
+___
+
+### outlineColor
+
+• `Optional` **outlineColor**: `string`
+
+___
+
+### textColor
+
+• **textColor**: `string`

package/docs/ExternalBlockDefinition.md

@@ -0,0 +1,46 @@
+# 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 | Type |
+| :------ | :------ |
+| `Factory` | [`BlockFactory`](../wiki/Home#blockfactory) |
+
+## Table of contents
+
+### Properties
+
+- [author](../wiki/ExternalBlockDefinition#author)
+- [blockDefinition](../wiki/ExternalBlockDefinition#blockdefinition)
+- [version](../wiki/ExternalBlockDefinition#version)
+
+## Properties
+
+### author
+
+• **author**: `string`
+
+Name of the author.
+
+___
+
+### blockDefinition
+
+• **blockDefinition**: [`BlockDefinition`](../wiki/BlockDefinition)<`Factory`\>
+
+Definition of the block.
+
+Will be registered to the staffbase app.
+
+___
+
+### version
+
+• **version**: `string`
+
+Current version of the widget.

package/docs/Home.md

@@ -4,37 +4,40 @@
 
 ### Interfaces
 
-- [BaseBlock](../wiki/Interface:%20BaseBlock)
-- [BlockAttributes](../wiki/Interface:%20BlockAttributes)
-- [BlockDefinition](../wiki/Interface:%20BlockDefinition)
-- [BlockElement](../wiki/Interface:%20BlockElement)
-- [ColorTheme](../wiki/Interface:%20ColorTheme)
-- [ExternalBlockDefinition](../wiki/Interface:%20ExternalBlockDefinition)
-- [SBColors](../wiki/Interface:%20SBColors)
-- [SBFileType](../wiki/Interface:%20SBFileType)
-- [SBImageEntity](../wiki/Interface:%20SBImageEntity)
-- [SBUserAvatar](../wiki/Interface:%20SBUserAvatar)
-- [SBUserProfile](../wiki/Interface:%20SBUserProfile)
-- [UserListItem](../wiki/Interface:%20UserListItem)
-- [UserListRequestQuery](../wiki/Interface:%20UserListRequestQuery)
-- [UserListResponse](../wiki/Interface:%20UserListResponse)
-- [WidgetApi](../wiki/Interface:%20WidgetApi)
+- [BaseBlock](../wiki/BaseBlock)
+- [BlockAttributes](../wiki/BlockAttributes)
+- [BlockDefinition](../wiki/BlockDefinition)
+- [BlockElement](../wiki/BlockElement)
+- [ColorTheme](../wiki/ColorTheme)
+- [ExternalBlockDefinition](../wiki/ExternalBlockDefinition)
+- [SBColors](../wiki/SBColors)
+- [SBFileType](../wiki/SBFileType)
+- [SBImageEntity](../wiki/SBImageEntity)
+- [SBUserAvatar](../wiki/SBUserAvatar)
+- [SBUserProfile](../wiki/SBUserProfile)
+- [UserListItem](../wiki/UserListItem)
+- [UserListRequestQuery](../wiki/UserListRequestQuery)
+- [UserListResponse](../wiki/UserListResponse)
+- [WidgetApi](../wiki/WidgetApi)
+
+### Type aliases
+
+- [BlockFactory](../wiki/Home#blockfactory)
+- [UserListSorting](../wiki/Home#userlistsorting)
 
 ## Type aliases
 
 ### BlockFactory
 
-Ƭ **BlockFactory**: (`Base`: () => [*BaseBlock*](../wiki/Interface:%20BaseBlock), `widgetApi`: [*WidgetApi*](../wiki/Interface:%20WidgetApi)) => CustomElementConstructor
+Ƭ **BlockFactory**: (`Base`: () => [`BaseBlock`](../wiki/BaseBlock), `widgetApi`: [`WidgetApi`](../wiki/WidgetApi)) => `CustomElementConstructor`
 
-Factory for the custom widgets.
+#### Type declaration
 
-**`param`** base class for the custom widgets to inherit from.
-The class itself is a subclass of `HTMLElement` of the relevant `window` object,
-with additional functionality.
+▸ (`Base`, `widgetApi`): `CustomElementConstructor`
 
-**`param`** API providing methods for additional information by the Staffbase framework
+Factory for the custom widgets.
 
-**`example`** 
+**`example`**
   const factory: BlockFactory = Base => {
 
     return class CustomBlock extends Base {
@@ -46,18 +49,16 @@ with additional functionality.
     }
   };
 
-#### Type declaration:
-
-▸ (`Base`: () => [*BaseBlock*](../wiki/Interface:%20BaseBlock), `widgetApi`: [*WidgetApi*](../wiki/Interface:%20WidgetApi)): CustomElementConstructor
+##### Parameters
 
-#### Parameters:
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `Base` | () => [`BaseBlock`](../wiki/BaseBlock) | base class for the custom widgets to inherit from. The class itself is a subclass of `HTMLElement` of the relevant `window` object, with additional functionality. |
+| `widgetApi` | [`WidgetApi`](../wiki/WidgetApi) | API providing methods for additional information by the Staffbase framework |
 
-| Name | Type |
-| :------ | :------ |
-| `Base` | () => [*BaseBlock*](../wiki/Interface:%20BaseBlock) |
-| `widgetApi` | [*WidgetApi*](../wiki/Interface:%20WidgetApi) |
+##### Returns
 
-**Returns:** CustomElementConstructor
+`CustomElementConstructor`
 
 ___