@apptane/react-ui-side-panel/dist/types/SidePanel.types.d.ts

Side panel component in Apptane React UI framework

import { OverlayProps } from "@apptane/react-ui-behaviors";
import { AppearanceProps } from "@apptane/react-ui-core";
import { PaneProps } from "@apptane/react-ui-pane";
import { SidePanelVisualAppearance } from "@apptane/react-ui-theme";
import PropTypes from "prop-types";
export declare type SidePanelEdge = "top" | "right" | "bottom" | "left";
export interface SidePanelProps extends OverlayProps, Omit<PaneProps, "appearance" | "height" | "h" | "minHeight" | "minH" | "maxHeight" | "maxH" | "width" | "w" | "minWidth" | "minW" | "maxWidth" | "maxW" | "elevation" | "inline" | "zIndex" | "animated" | "interactive">, AppearanceProps<SidePanelVisualAppearance> {
    /**
     * Size of the panel.
     * This property controls panel width or height depending on the `side`.
     */
    size: number | string;
    /**
     * Side to display the panel on.
     */
    side: SidePanelEdge;
    /**
     * Indicates whether close button must be visible.
     */
    closeButtonVisible?: boolean;
}
export declare const SidePanelPropTypes: {
    size: PropTypes.Requireable<string | number>;
    side: PropTypes.Validator<SidePanelEdge>;
    closeButtonVisible: PropTypes.Requireable<boolean>;
    colorMode: PropTypes.Requireable<import("@apptane/react-ui-core").ColorMode>;
    appearance: PropTypes.Requireable<any>;
    children: PropTypes.Requireable<any>;
    background: PropTypes.Requireable<string>;
    striped: PropTypes.Requireable<boolean>;
    elevation: PropTypes.Requireable<import("@apptane/react-ui-core").Elevation>;
    inline: PropTypes.Requireable<boolean>;
    zIndex: PropTypes.Requireable<number>;
    animated: PropTypes.Requireable<boolean>;
    interactivity: PropTypes.Requireable<string>;
    focusable: PropTypes.Requireable<boolean>;
    transitionDuration: PropTypes.Requireable<number>;
    scrollOnOverflow: PropTypes.Requireable<boolean>;
    overflow: PropTypes.Requireable<string>;
    accessibilityRole: PropTypes.Requireable<string>;
    style: PropTypes.Requireable<object>;
    horizontalAlignment: PropTypes.Requireable<import("@apptane/react-ui-core").ContentHorizontalAlignment>;
    verticalAlignment: PropTypes.Requireable<import("@apptane/react-ui-core").ContentVerticalAlignment>;
    orientation: PropTypes.Requireable<import("@apptane/react-ui-core").ContentOrientation>;
    wrap: PropTypes.Requireable<boolean>;
    height: PropTypes.Requireable<string | number>;
    width: PropTypes.Requireable<string | number>;
    minHeight: PropTypes.Requireable<string | number>;
    maxHeight: PropTypes.Requireable<string | number>;
    minWidth: PropTypes.Requireable<string | number>;
    maxWidth: PropTypes.Requireable<string | number>;
    h: PropTypes.Requireable<string | number>;
    w: PropTypes.Requireable<string | number>;
    minH: PropTypes.Requireable<string | number>;
    maxH: PropTypes.Requireable<string | number>;
    minW: PropTypes.Requireable<string | number>;
    maxW: PropTypes.Requireable<string | number>;
    basis: PropTypes.Requireable<string | number>;
    grow: PropTypes.Requireable<number | boolean>;
    shrink: PropTypes.Requireable<number | boolean>;
    border: PropTypes.Requireable<string | boolean>;
    borderStyle: PropTypes.Requireable<string>;
    borderWidth: PropTypes.Requireable<number>;
    borderTop: PropTypes.Requireable<string | boolean>;
    borderTopWidth: PropTypes.Requireable<number>;
    borderRight: PropTypes.Requireable<string | boolean>;
    borderRightWidth: PropTypes.Requireable<number>;
    borderBottom: PropTypes.Requireable<string | boolean>;
    borderBottomWidth: PropTypes.Requireable<number>;
    borderLeft: PropTypes.Requireable<string | boolean>;
    borderLeftWidth: PropTypes.Requireable<number>;
    cornerRadius: PropTypes.Requireable<number>;
    cornerTopLeftRadius: PropTypes.Requireable<number>;
    cornerTopRightRadius: PropTypes.Requireable<number>;
    cornerBottomLeftRadius: PropTypes.Requireable<number>;
    cornerBottomRightRadius: PropTypes.Requireable<number>;
    padding: PropTypes.Requireable<string | number>;
    paddingTop: PropTypes.Requireable<string | number>;
    paddingRight: PropTypes.Requireable<string | number>;
    paddingBottom: PropTypes.Requireable<string | number>;
    paddingLeft: PropTypes.Requireable<string | number>;
    p: PropTypes.Requireable<string | number>;
    pt: PropTypes.Requireable<string | number>;
    pr: PropTypes.Requireable<string | number>;
    pb: PropTypes.Requireable<string | number>;
    pl: PropTypes.Requireable<string | number>;
    margin: PropTypes.Requireable<string | number>;
    marginTop: PropTypes.Requireable<string | number>;
    marginRight: PropTypes.Requireable<string | number>;
    marginBottom: PropTypes.Requireable<string | number>;
    marginLeft: PropTypes.Requireable<string | number>;
    m: PropTypes.Requireable<string | number>;
    mt: PropTypes.Requireable<string | number>;
    mr: PropTypes.Requireable<string | number>;
    mb: PropTypes.Requireable<string | number>;
    ml: PropTypes.Requireable<string | number>;
    visible: PropTypes.Requireable<boolean>;
    backdrop: PropTypes.Requireable<boolean>;
    shouldCaptureFocus: PropTypes.Requireable<boolean>;
    shouldCloseOnEsc: PropTypes.Requireable<boolean>;
    shouldCloseOnBackdropClick: PropTypes.Requireable<boolean>;
    onCloseOnEsc: PropTypes.Requireable<(...args: any[]) => any>;
    onClosing: PropTypes.Requireable<(...args: any[]) => any>;
    enableBodyScroll: PropTypes.Requireable<boolean>;
};