Options
All
  • Public
  • Public/Protected
  • All
Menu

Filter component that is in charge of managing one to many FilterCards as well as the data store beind them

Hierarchy

  • Component<FilterProps, FilterState>
    • default

Index

Constructors

constructor

  • new default(props: FilterProps): default
  • Parameters

    • props: FilterProps

    Returns default

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. 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 props

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

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<FilterState>

Optional Static 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<FilterProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

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

addRestriction

  • addRestriction(): void
  • Add a restriction with the currentRestrictionIDCount as its ID then increment and update the state

    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

componentDidMount

  • componentDidMount(): void
  • Handles computing the tableAttributes array given the primary and secondary attributes

    Returns void

componentDidUpdate

  • componentDidUpdate(prevProps: FilterProps, prevState: FilterState): void
  • Upon state change of restrictions, check if any of them are valid, if so then call the fetchTableContent function appropriately

    Parameters

    • prevProps: FilterProps
    • prevState: FilterState

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

deleteFilterCard

  • deleteFilterCard(index: number): void
  • Parameters

    • index: number

      Location of the restriction object to be deleted

    Returns void

forceUpdate

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

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

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<FilterProps>, prevState: Readonly<FilterState>): 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<FilterProps>
    • prevState: Readonly<FilterState>

    Returns any

render

  • render(): Element
  • Returns Element

setState

  • setState<K>(state: null | FilterState | ((prevState: Readonly<FilterState>, props: Readonly<FilterProps>) => null | FilterState | Pick<FilterState, K>) | Pick<FilterState, K>, callback?: () => void): void
  • Type parameters

    • K: "restrictionsBuffer" | "tableAttributes" | "currentRestrictionIDCount" | "restrictionChangeTimeout"

    Parameters

    • state: null | FilterState | ((prevState: Readonly<FilterState>, props: Readonly<FilterProps>) => null | FilterState | Pick<FilterState, K>) | Pick<FilterState, K>
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<FilterProps>, nextState: Readonly<FilterState>, 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<FilterProps>
    • nextState: Readonly<FilterState>
    • nextContext: any

    Returns boolean

updateRestriction

  • updateRestriction(index: number, restriction: default): void
  • Parameters

    • index: number

      Location of the data in the restriction array to be modified

    • restriction: default

      The new restriction to replace the old restriction object

    Returns void

Generated using TypeDoc