streamlit-component-lib/dist/StreamlitReact.d.ts

Support code for Streamlit Components

/**
 * Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022)
 *
 * 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 React from "react";
import { Theme } from "./streamlit";
/**
 * Props passed to custom Streamlit components.
 */
export interface ComponentProps<ArgType = any> {
    /** Named dictionary of arguments passed from Python. */
    args: ArgType;
    /** The component's width. */
    width: number;
    /**
     * True if the component should be disabled.
     * All components get disabled while the app is being re-run,
     * and become re-enabled when the re-run has finished.
     */
    disabled: boolean;
    /** Theme definition dictionary passed from the main client.*/
    theme?: Theme;
}
/**
 * Optional Streamlit React-based component base class.
 *
 * You are not required to extend this base class to create a Streamlit
 * component. If you decide not to extend it, you should implement the
 * `componentDidMount` and `componentDidUpdate` functions in your own class,
 * so that your plugin properly resizes.
 */
export declare class StreamlitComponentBase<S = {}, ArgType = any> extends React.PureComponent<ComponentProps<ArgType>, S> {
    componentDidMount(): void;
    componentDidUpdate(): void;
}
/**
 * Wrapper for React-based Streamlit components.
 *
 * Bootstraps the communication interface between Streamlit and the component.
 */
export declare function withStreamlitConnection<ArgType = any>(WrappedComponent: React.ComponentType<ComponentProps>): React.ComponentType;