Class TogglerTree

Index

Constructors

Properties

Methods

_getTogglersMap _reduceTogglerState disableToggler enableToggler getDisableState getState getVisibilityState readFromLocalStorage reduceTogglerStateFromRoot reduceTogglerStateFromTogglerId serialize setDefaultState setState setStateFromBitfield setStateFromUrlParams writeToLocalStorage create

Constructors

constructor

new TogglerTree(tree: TogglerGroup): TogglerTree
Parameters
- tree: TogglerGroup
Returns TogglerTree

Properties

_tree

_tree: TogglerGroup

Methods

_getTogglersMap

_getTogglersMap(): { [key: string]: Toggler }
Returns { [key: string]: Toggler }

_reduceTogglerState

_reduceTogglerState(
    toggler: Toggler | TogglerGroup,
    currentReducedParentsState: boolean,
    callback: (
        currentToggler: Toggler | TogglerGroup,
        reducedParentsState: boolean,
    ) => void,
): void
Parameters
- toggler: Toggler | TogglerGroup
- currentReducedParentsState: boolean
- callback: (currentToggler: Toggler | TogglerGroup, reducedParentsState: boolean) => void
Returns void

disableToggler

disableToggler(togglerId: TogglerEnumWithRoot): void
Parameters
- togglerId: TogglerEnumWithRoot
Returns void

enableToggler

enableToggler(togglerId: TogglerEnumWithRoot): void
Parameters
- togglerId: TogglerEnumWithRoot
Returns void

getDisableState

getDisableState(): TogglerStateMap
Returns TogglerStateMap

getState

getState(): TogglerStateMap
Returns TogglerStateMap

getVisibilityState

getVisibilityState(): TogglerStateMap
Returns TogglerStateMap

readFromLocalStorage

readFromLocalStorage(): void
Returns void

reduceTogglerStateFromRoot

reduceTogglerStateFromRoot(
    callback: (
        toggler: Toggler | TogglerGroup,
        _parentState: boolean,
    ) => void,
): void
Parameters
- callback: (toggler: Toggler | TogglerGroup, _parentState: boolean) => void
Returns void

reduceTogglerStateFromTogglerId

reduceTogglerStateFromTogglerId(
    togglerId: TogglerEnumWithRoot,
    callback: (
        currentToggler: Toggler | TogglerGroup,
        reducedParentsState: boolean,
    ) => void,
): void
Parameters
- togglerId: TogglerEnumWithRoot
- callback: (currentToggler: Toggler | TogglerGroup, reducedParentsState: boolean) => void
Returns void

serialize

serialize(): bigint
Returns bigint

setDefaultState

setDefaultState(): void
Returns void

setState

setState(state: Partial<TogglerStateMap>): void
Parameters
- state: Partial<TogglerStateMap>
Returns void

setStateFromBitfield

setStateFromBitfield(bitfield: bigint): void
Parameters
- bitfield: bigint
Returns void

setStateFromUrlParams

setStateFromUrlParams(urlParams?: {}): void
Parameters
- urlParams: {} = {}
Returns void

writeToLocalStorage

writeToLocalStorage(): void
Returns void

`Static`create

create(): TogglerTree
Returns TogglerTree