@awsui/components-react
Version:
On July 19th, 2022, we launched [Cloudscape Design System](https://cloudscape.design). Cloudscape is an evolution of AWS-UI. It consists of user interface guidelines, front-end components, design resources, and development tools for building intuitive, en
59 lines • 2.37 kB
TypeScript
import React from 'react';
import { BaseComponentProps } from '../internal/base-component';
export interface SplitPanelProps extends BaseComponentProps {
/**
* Header of the split panel.
*/
header: string;
children: React.ReactNode;
/**
* Determines whether the split panel collapses or hides completely when closed.
*/
closeBehavior?: 'collapse' | 'hide';
/**
* When set to `true`, the preferences button is not displayed.
*/
hidePreferencesButton?: boolean;
/**
* An object containing all the necessary localized strings required by the component.
* - `closeButtonAriaLabel` - The text of the panel close button aria label.
* - `openButtonAriaLabel` - The text of the panel open button aria label.
* - `preferencesTitle` - The text of the preferences modal header.
* - `preferencesPositionLabel` - The text of the position preference label.
* - `preferencesPositionDescription` - The text of the position preference description.
* - `preferencesPositionSide` - The text of the side position preference label.
* - `preferencesPositionBottom` - The text of the bottom position preference label.
* - `preferencesConfirm` - The text of the preference modal confirm button.
* - `preferencesCancel` - The text of the preference modal cancel button.
* - `resizeHandleAriaLabel` - The label of the resize handle aria label.
* @i18n
*/
i18nStrings?: SplitPanelProps.I18nStrings;
}
export declare namespace SplitPanelProps {
interface I18nStrings {
closeButtonAriaLabel?: string;
openButtonAriaLabel?: string;
preferencesTitle?: string;
preferencesPositionLabel?: string;
preferencesPositionDescription?: string;
preferencesPositionSide?: string;
preferencesPositionBottom?: string;
preferencesConfirm?: string;
preferencesCancel?: string;
resizeHandleAriaLabel?: string;
}
}
export interface SplitPanelContentProps {
style: React.CSSProperties;
baseProps: BaseComponentProps;
isOpen?: boolean;
splitPanelRef?: React.Ref<any>;
cappedSize: number;
panelHeaderId: string;
resizeHandle: React.ReactNode;
header: React.ReactNode;
children: React.ReactNode;
onToggle: () => void;
}
//# sourceMappingURL=interfaces.d.ts.map