Options
All
  • Public
  • Public/Protected
  • All
Menu

The TabBar class. Essentially a list of Tabs.

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

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

props

props: Readonly<object> & Readonly<TabBarProps>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<TabBarState>

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<TabBarProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

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

addTab

  • addTab(inputType: string): void
  • This method adds a tab to the TabBar by updating the relevant state which triggers a re-render.

    Parameters

    • inputType: string

      The type of input that this tab accepts.

    Returns void

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

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • 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

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<TabBarProps>, 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<TabBarProps>, nextState: Readonly<TabBarState>, nextContext: any): void

forceUpdate

  • forceUpdate(callBack?: undefined | function): void
  • Parameters

    • Optional callBack: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

  • 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

    Returns SS | null

handleAddTabBtnClick

  • handleAddTabBtnClick(): void

handleCloseModal

  • handleCloseModal(): void
  • Method that modifies the state to close the modal. NOTE: This method will be passed to the modal component as a prop so that it can be bound to the modal's close button click event.

    Returns void

handleTabClick

  • handleTabClick(i: number): void
  • Set the index of the selected tab to be the given tab index. NOTE: Each tab will be given one of these methods wrapped in a lambda to close over the correct index. This allows each tab to not know it's own index. Alternatively we could pass the index of each tab as a prop, and pass the method without a lambda so each tab could construct the call itself.

    Parameters

    • i: number

      The index of the clicked tab.

    Returns void

removeTab

  • removeTab(i: number): void
  • Remove a tab from the TabBar by modifying the state which triggers a re-render.

    Parameters

    • i: number

      The index of the tab to remove.

    Returns void

render

  • render(): Element

setState

  • setState<K>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof TabBarState

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<TabBarProps>, nextState: Readonly<TabBarState>, 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

    Returns boolean

Generated using TypeDoc