WrapperLifecycle.ts

/*
Copyright 2023 Mikhail Aheichyk
Copyright 2023 Nordeck IT + Consulting GmbH.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { ComponentType, PropsWithChildren } from "react";

/**
 * Wrapper lifecycle events
 */
export enum WrapperLifecycle {
    /**
     * An event to request the wrapper. It is sent by Element to get the wrapper provided by the module if any.
     */
    Wrapper = "wrapper",
}

/**
 * Opts object that is populated with a Wrapper.
 */
export type WrapperOpts = {
    /**
     * A Wrapper React Component to be rendered around the Matrix Chat.
     */
    Wrapper: ComponentType<PropsWithChildren<{}>>;
};

/**
 * Helper type that documents how to implement a wrapper listener.
 */
export type WrapperListener = (opts: WrapperOpts) => void;