Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TriggerSwitch

Hierarchy

  • ReduxSwitch
    • TriggerSwitch

Index

Constructors

constructor

Properties

callbacks

callbacks: {} = {}

Type declaration

  • [eventName: string]: AbstractCallback[]

Readonly componentClass

componentClass: ComponentClass<LabUiSwitchProps, any> = ReduxSwitch

Protected containerElement

containerElement: null | Element = null

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

Readonly dataActionType

dataActionType: string

deactivatesUi

deactivatesUi: boolean = false

Readonly debug

debug: boolean = false

defaultReducerNames

defaultReducerNames: string[] = ...

Protected defaultState

defaultState: DefaultSwitchProps = ...

Protected dispatchers

dispatchers: {} = {}

Type declaration

  • [callbackName: string]: (self: any) => AnyAction
      • (self: any): AnyAction
      • Parameters

        • self: any

        Returns AnyAction

Readonly hasData

hasData: true = true

invertedActiveState

invertedActiveState: boolean = false

Readonly name

name: string = 'pure ReduxComponentBaseClass'

Readonly props

props: Readonly<MinimalPropRequirement> & Readonly<{ children?: ReactNode }>

Readonly reducers

reducers: {} = {}

Type declaration

  • [reducerName: string]: Reducer

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: DefaultSwitchProps = {}

store

store: Store<any, AnyAction>

uiActive

uiActive: boolean = false

Static Optional contextType

contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<MinimalPropRequirement>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<MinimalPropRequirement>, nextState: Readonly<any>, nextContext: any): void

addCallback

  • addCallback(eventName: string, callback: (self: any) => any): void

addDefaultCallback

  • addDefaultCallback(): void

addDispatcher

  • addDispatcher(dispatcherName: string, callback: (self: any) => AnyAction): void

addOnChangeCallback

  • addOnChangeCallback(callback: (self: any) => any): void
  • Parameters

    • callback: (self: any) => any
        • (self: any): any
        • Parameters

          • self: any

          Returns any

    Returns void

addReducer

  • addReducer(reducerName: string, reducer: Reducer<any, AnyAction>, allowDefaultReducerOverwrite?: boolean): void

Protected callCallsbacks

  • callCallsbacks(eventName: string, self: any): void

Protected cleanState

  • cleanState(): AbstractTriggerPropRequirement

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<MinimalPropRequirement>, prevState: Readonly<any>, snapshot?: any): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<MinimalPropRequirement>
    • prevState: Readonly<any>
    • Optional snapshot: any

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<MinimalPropRequirement>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<MinimalPropRequirement>, nextState: Readonly<any>, nextContext: any): void

debugLog

  • debugLog(...args: any[]): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

getMapDispatchToProps

  • getMapDispatchToProps(): (dispatch: Dispatch<AnyAction>) => {} | DispatchObjectState
  • Returns (dispatch: Dispatch<AnyAction>) => {} | DispatchObjectState

      • (dispatch: Dispatch<AnyAction>): {} | DispatchObjectState
      • Parameters

        • dispatch: Dispatch<AnyAction>

        Returns {} | DispatchObjectState

getReducers

  • getReducers(): {}

getReduxContainer

  • getReduxContainer(): ConnectedComponent<ComponentClass<MinimalPropRequirement, any>, Omit<ClassAttributes<Component<MinimalPropRequirement, any, any>> & MinimalPropRequirement, never>>
  • Returns ConnectedComponent<ComponentClass<MinimalPropRequirement, any>, Omit<ClassAttributes<Component<MinimalPropRequirement, any, any>> & MinimalPropRequirement, never>>

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<MinimalPropRequirement>, prevState: Readonly<any>): any
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<MinimalPropRequirement>
    • prevState: Readonly<any>

    Returns any

Protected isDisabled

  • isDisabled(uiActive: boolean): boolean

mapStateToProps

  • mapStateToProps(state: GlobalBaseUiState): BaseUiState

onChangeCallback

  • onChangeCallback(self: ReduxSwitch): (event: ChangeEvent<HTMLInputElement>) => void
  • Parameters

    • self: ReduxSwitch

    Returns (event: ChangeEvent<HTMLInputElement>) => void

      • (event: ChangeEvent<HTMLInputElement>): void
      • Parameters

        • event: ChangeEvent<HTMLInputElement>

        Returns void

Protected pureSwitchProps

  • pureSwitchProps(): SwitchProps

render

  • render(): Element

setData

  • setData(data: any): void

Protected setInitState

  • setInitState(): void

setState

  • setState<K>(state: any, callback?: () => void): void
  • Type parameters

    • K: string | number | symbol

    Parameters

    • state: any
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

setStore

  • setStore(store: Store<any, AnyAction>): void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<MinimalPropRequirement>, nextState: Readonly<any>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<MinimalPropRequirement>
    • nextState: Readonly<any>
    • nextContext: any

    Returns boolean

show

  • show(): void

Protected uiActiveAction

  • uiActiveAction(self: AbstractTrigger): AnyAction

Protected uiActiveReducer

  • uiActiveReducer(state?: BaseUiState, action: AnyAction): BaseUiState

Protected validateContainer

  • validateContainer(container: null | string | Element): void

warn

  • warn(...args: any[]): void

Generated using TypeDoc