ant-design-vue/types/layout/layout-sider.d.ts

73 lines
1.5 KiB
TypeScript
Raw Normal View History

import { CSSProperties, Slot, VNodeChild } from 'vue';
// Project: https://github.com/vueComponent/ant-design-vue
// Definitions by: akki-jat <https://github.com/akki-jat>
// Definitions: https://github.com/vueComponent/ant-design-vue/types
2019-01-12 03:33:27 +00:00
import { AntdComponent } from '../component';
export interface LayoutSiderProps {
/**
* whether can be collapsed
* @default false
* @type boolean
*/
collapsible?: boolean;
/**
* to set the current status
* @type boolean
*/
collapsed?: boolean;
/**
* to set the initial status
* @default false
* @type boolean
*/
defaultCollapsed?: boolean;
/**
* reverse direction of arrow, for a sider that expands from the right
* @default false
* @type boolean
*/
reverseArrow?: boolean;
/**
* specify the customized trigger, set to null to hide the trigger
* @type string | | VNodeChild | JSX.Element
*/
trigger?: string | VNodeChild | JSX.Element;
/**
* width of the sidebar
* @default 200
* @type number | string
*/
width?: number | string;
/**
* width of the collapsed sidebar, by setting to 0 a special trigger will appear
2019-01-05 03:24:56 +00:00
* @default 80
* @type number
*/
collapsedWidth?: number;
/**
* breakpoints of the responsive layout
* @type string
*/
breakpoint?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
/**
* color theme of the sidebar
* @default 'dark'
* @type string
*/
theme?: 'light' | 'dark';
}
export declare class LayoutSider extends AntdComponent {
$props: LayoutSiderProps;
}