Юниверс DG SDK UI
v2.15.0

Интерфейс PageComponentType

Интерфейс React-компонента для отображения страниц.

interface PageComponentType {
    context: any;
    isInitialWikiPage?: boolean;
    onBeforeUnload?: () => string;
    props: Readonly<{}> & Readonly<{ children?: ReactNode }>;
    refs: { [key: string]: ReactInstance };
    state: Readonly<S>;
    wikiPage?: () => string;
    componentDidCatch?(error: Error, errorInfo: ErrorInfo): void;
    componentDidMount?(): void;
    componentDidUpdate?(
        prevProps: Readonly<P>,
        prevState: Readonly<S>,
        snapshot?: any,
    ): void;
    componentWillMount?(): void;
    componentWillReceiveProps?(nextProps: Readonly<P>, nextContext: any): void;
    componentWillUnmount?(): void;
    componentWillUpdate?(
        nextProps: Readonly<P>,
        nextState: Readonly<S>,
        nextContext: any,
    ): void;
    forceUpdate(callback?: () => void): void;
    getSnapshotBeforeUpdate?(
        prevProps: Readonly<P>,
        prevState: Readonly<S>,
    ): any;
    render(): ReactNode;
    setState<K extends never>(
        state:
            | {}
            | (
                (
                    prevState: Readonly<S>,
                    props: Readonly<P>,
                ) => {} | Pick<{}, K> | null
            )
            | Pick<{}, K>
            | null,
        callback?: () => void,
    ): void;
    shouldComponentUpdate?(
        nextProps: Readonly<P>,
        nextState: Readonly<S>,
        nextContext: any,
    ): boolean;
    UNSAFE_componentWillMount?(): void;
    UNSAFE_componentWillReceiveProps?(
        nextProps: Readonly<P>,
        nextContext: any,
    ): void;
    UNSAFE_componentWillUpdate?(
        nextProps: Readonly<P>,
        nextState: Readonly<S>,
        nextContext: any,
    ): void;
}

Иерархия (Просмотр сводки)

Индекс

Свойства

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>
isInitialWikiPage?: boolean

Флаг начальной Wiki-страницы.

onBeforeUnload?: () => string

Функция, вызываемая перед выгрузкой страницы.

props: Readonly<{}> & Readonly<{ children?: ReactNode }>
refs: { [key: string]: ReactInstance }
state: Readonly<S>
wikiPage?: () => string

Функция получения имени Wiki-страницы.

Методы

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Параметры

    Возвращает void

  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Возвращает 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.

    Параметры

    • prevProps: Readonly<P>
    • prevState: Readonly<S>
    • Optionalsnapshot: any

    Возвращает 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.

    Возвращает void

  • Параметры

    • Optionalcallback: () => void

    Возвращает void

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

    Параметры

    • prevProps: Readonly<P>
    • prevState: Readonly<S>

    Возвращает any

  • Параметры типа

    • K extends never

    Параметры

    • state:
          | {}
          | ((prevState: Readonly<S>, props: Readonly<P>) => {} | Pick<{}, K> | null)
          | Pick<{}, K>
          | null
    • Optionalcallback: () => void

    Возвращает void

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

    Параметры

    • nextProps: Readonly<P>
    • nextState: Readonly<S>
    • nextContext: any

    Возвращает boolean