Options
All
  • Public
  • Public/Protected
  • All
Menu

Class component to insertion of tuples

Hierarchy

  • Component<InsertTupleProps, InsertTupleState>
    • default

Index

Constructors

constructor

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

    • props: InsertTupleProps

    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<InsertTupleProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<InsertTupleState>

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<InsertTupleProps>, nextState: Readonly<InsertTupleState>, nextContext: any): 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
  • Handle cases with enums on load by setting the deafult value to the first enum option

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<InsertTupleProps>, prevState: Readonly<InsertTupleState>, 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<InsertTupleProps>
    • prevState: Readonly<InsertTupleState>
    • Optional snapshot: any

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

copyTuple

  • copyTuple(event: MouseEvent<HTMLButtonElement, MouseEvent>): void
  • Helper function to handle copy over of the selected tuple into the insert fields by updating the tupleBuffer state.

    Parameters

    • event: MouseEvent<HTMLButtonElement, MouseEvent>

    Returns void

forceUpdate

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

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

    Returns void

Optional getSnapshotBeforeUpdate

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

    Returns any

handleChange

  • handleChange(event: ChangeEvent<HTMLInputElement> | ChangeEvent<HTMLSelectElement>, attributeName: string): void
  • Helper function to handle attribute changes by updating tupleBuffer accordingly

    Parameters

    • event: ChangeEvent<HTMLInputElement> | ChangeEvent<HTMLSelectElement>

      Event object that come from the onChange function

    • attributeName: string

      Attribute name of the change, this is used to access the tupleBuffer object members to set the value

    Returns void

onSubmit

  • onSubmit(event: FormEvent<HTMLFormElement>): void
  • On submit handle function which checks that all attributes of the tupleBuffer object are filled out correctly based upon the info provided by this.props.tableAttributeInfo such as nullable? autoIncrement?, etc.

    Parameters

    • event: FormEvent<HTMLFormElement>

      Event object from the standard OnSubmit function

    Returns void

render

  • render(): Element
  • Returns Element

resetToNull

  • resetToNull(tableAttribute: default): void
  • Function dealing with when user clicks on the reset icon for nullable input field. TODO: Align behavior with the edge case specs - whether to null, or fill with default

    Parameters

    • tableAttribute: default

      Table attribute object so the function can extract the attributeName

    Returns void

setState

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

    • K: "tupleBuffer" | "errorMessage"

    Parameters

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

    Returns void

Optional shouldComponentUpdate

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

    Returns boolean

Generated using TypeDoc