UNPKG

@ticmakers-react-native/dialog

Version:

TIC Makers - React Native Dialog

259 lines (146 loc) 5.68 kB
[@ticmakers-react-native/dialog](../README.md) > ["DialogManager/DialogManager"](../modules/_dialogmanager_dialogmanager_.md) > [DialogManager](../classes/_dialogmanager_dialogmanager_.dialogmanager.md) # Class: DialogManager Class to define the dialog manager component ## Hierarchy **DialogManager** ## Index ### Constructors * [constructor](_dialogmanager_dialogmanager_.dialogmanager.md#constructor) ### Properties * [destroyTimeout](_dialogmanager_dialogmanager_.dialogmanager.md#destroytimeout) * [dialogs](_dialogmanager_dialogmanager_.dialogmanager.md#dialogs) ### Accessors * [currentDialog](_dialogmanager_dialogmanager_.dialogmanager.md#currentdialog) ### Methods * [add](_dialogmanager_dialogmanager_.dialogmanager.md#add) * [destroy](_dialogmanager_dialogmanager_.dialogmanager.md#destroy) * [dismiss](_dialogmanager_dialogmanager_.dialogmanager.md#dismiss) * [dismissAll](_dialogmanager_dialogmanager_.dialogmanager.md#dismissall) * [onDialogDismissed](_dialogmanager_dialogmanager_.dialogmanager.md#ondialogdismissed) * [show](_dialogmanager_dialogmanager_.dialogmanager.md#show) * [showOne](_dialogmanager_dialogmanager_.dialogmanager.md#showone) * [update](_dialogmanager_dialogmanager_.dialogmanager.md#update) --- ## Constructors <a id="constructor"></a> ### constructor**new DialogManager**(): [DialogManager](_dialogmanager_dialogmanager_.dialogmanager.md) *Defined in DialogManager/DialogManager.tsx:22* Creates an instance of DialogManager. **Returns:** [DialogManager](_dialogmanager_dialogmanager_.dialogmanager.md) ___ ## Properties <a id="destroytimeout"></a> ### destroyTimeout **● destroyTimeout**: *`number`* *Defined in DialogManager/DialogManager.tsx:16* A number millisecond to define the time to destroy the dialog list components *__type__*: {number} *__default__*: 150 ___ <a id="dialogs"></a> ### dialogs **● dialogs**: *`RootSiblings`[]* *Defined in DialogManager/DialogManager.tsx:22* A list of dialogs to show *__type__*: {RootSiblings\[\]} ___ ## Accessors <a id="currentdialog"></a> ### currentDialog **get currentDialog**(): `RootSiblings` *Defined in DialogManager/DialogManager.tsx:37* Method to get the current dialog *__readonly__*: *__type__*: {RootSiblings} **Returns:** `RootSiblings` ___ ## Methods <a id="add"></a> ### add**add**(props: *[IDialogProps](../interfaces/_dialogcomponent_index_d_.idialogprops.md)*, callback?: *`undefined` \| `function`*): `void` *Defined in DialogManager/DialogManager.tsx:46* Method to add a new dialog to the list **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | props | [IDialogProps](../interfaces/_dialogcomponent_index_d_.idialogprops.md) | A object of the DialogProps | | `Optional` callback | `undefined` \| `function` | **Returns:** `void` ___ <a id="destroy"></a> ### destroy ▸ **destroy**(): `void` *Defined in DialogManager/DialogManager.tsx:63* Method to destroy a dialog of the list **Returns:** `void` ___ <a id="dismiss"></a> ### dismiss**dismiss**(callback?: *`undefined` \| `function`*): `void` *Defined in DialogManager/DialogManager.tsx:117* Method to dismiss the dialog of the list **Parameters:** | Name | Type | | ------ | ------ | | `Optional` callback | `undefined` \| `function` | **Returns:** `void` ___ <a id="dismissall"></a> ### dismissAll ▸ **dismissAll**(callback?: *`undefined` \| `function`*): `void` *Defined in DialogManager/DialogManager.tsx:125* Method to dismiss all the dialogs of the list **Parameters:** | Name | Type | | ------ | ------ | | `Optional` callback | `undefined` \| `function` | **Returns:** `void` ___ <a id="ondialogdismissed"></a> ### onDialogDismissed**onDialogDismissed**(onDismiss?: *`undefined` \| `function`*): `void` *Defined in DialogManager/DialogManager.tsx:72* Method that fire when the a dialog of the list is dismissed **Parameters:** | Name | Type | | ------ | ------ | | `Optional` onDismiss | `undefined` \| `function` | **Returns:** `void` ___ <a id="show"></a> ### show ▸ **show**(props: *[IDialogProps](../interfaces/_dialogcomponent_index_d_.idialogprops.md)*, callback?: *`undefined` \| `function`*): `void` *Defined in DialogManager/DialogManager.tsx:99* Method to show the dialog of the list **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | props | [IDialogProps](../interfaces/_dialogcomponent_index_d_.idialogprops.md) | An object of the DialogProps | | `Optional` callback | `undefined` \| `function` | **Returns:** `void` ___ <a id="showone"></a> ### showOne**showOne**(props: *[IDialogProps](../interfaces/_dialogcomponent_index_d_.idialogprops.md)*, callback?: *`undefined` \| `function`*): `void` *Defined in DialogManager/DialogManager.tsx:108* Method to show the dialog one time of the list **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | props | [IDialogProps](../interfaces/_dialogcomponent_index_d_.idialogprops.md) | An object of the DialogProps | | `Optional` callback | `undefined` \| `function` | **Returns:** `void` ___ <a id="update"></a> ### update ▸ **update**(props: *[IDialogProps](../interfaces/_dialogcomponent_index_d_.idialogprops.md)*, callback?: *`undefined` \| `function`*): `void` *Defined in DialogManager/DialogManager.tsx:82* Method to update a dialog of the list **Parameters:** | Name | Type | Description | | ------ | ------ | ------ | | props | [IDialogProps](../interfaces/_dialogcomponent_index_d_.idialogprops.md) | An object of the DialogProps | | `Optional` callback | `undefined` \| `function` | **Returns:** `void` ___