UNPKG

pageguide

Version:

A simple library to light page-elements up, even in complex z-index rich applications.

185 lines (102 loc) 4.28 kB
[pageguide](../README.md) > [ButtonGUI](../classes/buttongui.md) # Class: ButtonGUI ## Hierarchy **ButtonGUI** ## Implements * [IButtonDefinition](../interfaces/ibuttondefinition.md) ## Index ### Constructors * [constructor](buttongui.md#constructor) ### Properties * [bottom](buttongui.md#bottom) * [content](buttongui.md#content) * [left](buttongui.md#left) * [markup](buttongui.md#markup) * [position](buttongui.md#position) * [right](buttongui.md#right) * [top](buttongui.md#top) ### Methods * [toStyleString](buttongui.md#tostylestring) ### Object literals * [style](buttongui.md#style) --- ## Constructors <a id="constructor"></a> ### constructor**new ButtonGUI**(dto?: *[IButtonDefinition](../interfaces/ibuttondefinition.md)*): [ButtonGUI](buttongui.md) *Defined in [GUI/ButtonGUI.ts:15](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L15)* **Parameters:** | Param | Type | | ------ | ------ | | `Optional` dto | [IButtonDefinition](../interfaces/ibuttondefinition.md) | **Returns:** [ButtonGUI](buttongui.md) ___ ## Properties <a id="bottom"></a> ### bottom **● bottom**: * `number` &#124; `string` * = "initial" *Implementation of [IButtonDefinition](../interfaces/ibuttondefinition.md).[bottom](../interfaces/ibuttondefinition.md#bottom)* *Defined in [GUI/ButtonGUI.ts:8](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L8)* ___ <a id="content"></a> ### content **● content**: *`string`* = "i" *Implementation of [IButtonDefinition](../interfaces/ibuttondefinition.md).[content](../interfaces/ibuttondefinition.md#content)* *Defined in [GUI/ButtonGUI.ts:10](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L10)* ___ <a id="left"></a> ### left **● left**: * `number` &#124; `string` * = "initial" *Implementation of [IButtonDefinition](../interfaces/ibuttondefinition.md).[left](../interfaces/ibuttondefinition.md#left)* *Defined in [GUI/ButtonGUI.ts:9](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L9)* ___ <a id="markup"></a> ### markup **● markup**: *`HTMLButtonElement`* *Defined in [GUI/ButtonGUI.ts:15](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L15)* ___ <a id="position"></a> ### position **● position**: *`string`* = "absolute" *Implementation of [IButtonDefinition](../interfaces/ibuttondefinition.md).[position](../interfaces/ibuttondefinition.md#position)* *Defined in [GUI/ButtonGUI.ts:5](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L5)* ___ <a id="right"></a> ### right **● right**: * `number` &#124; `string` * = 32 *Implementation of [IButtonDefinition](../interfaces/ibuttondefinition.md).[right](../interfaces/ibuttondefinition.md#right)* *Defined in [GUI/ButtonGUI.ts:7](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L7)* ___ <a id="top"></a> ### top **● top**: * `number` &#124; `string` * = 32 *Implementation of [IButtonDefinition](../interfaces/ibuttondefinition.md).[top](../interfaces/ibuttondefinition.md#top)* *Defined in [GUI/ButtonGUI.ts:6](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L6)* ___ ## Methods <a id="tostylestring"></a> ### `<Private>` toStyleString**toStyleString**(value: * `string` &#124; `number`*): `string` *Defined in [GUI/ButtonGUI.ts:40](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L40)* **Parameters:** | Param | Type | | ------ | ------ | | value | `string` &#124; `number`| **Returns:** `string` ___ ## Object literals <a id="style"></a> ### style **style**: *`object`* *Implementation of [IButtonDefinition](../interfaces/ibuttondefinition.md).[style](../interfaces/ibuttondefinition.md#style)* *Defined in [GUI/ButtonGUI.ts:11](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L11)* <a id="style.padding_right"></a> #### padding-right **● padding-right**: *`string`* = "2px" *Defined in [GUI/ButtonGUI.ts:12](https://github.com/Diligentia-Uitgeverij/pageguide/blob/7a12dd3/src/GUI/ButtonGUI.ts#L12)* ___ ___