github
/
ant-design-vue
mirror of https://github.com/vueComponent/ant-design-vue
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: update type descriptions (#2686) 

* chore: update type descriptions

* fix: object

* fix: add pub
pull/2695/head
xrkffgg 2020-08-17 13:52:44 +08:00 committed by GitHub
parent 61ec4adafa
commit 25a97ec5ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 67 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
types/descriptions/descriptions-item.d.ts vendored
View File

@ -2,19 +2,22 @@
// Definitions by: akki-jat <https://github.com/akki-jat> // Definitions by: akki-jat <https://github.com/akki-jat>
// Definitions: https://github.com/vueComponent/ant-design-vue/types // Definitions: https://github.com/vueComponent/ant-design-vue/types
import { VNodeChild } from 'vue';
import { AntdComponent } from '../component'; import { AntdComponent } from '../component';
export declare class DescriptionsItem extends AntdComponent { export declare class DescriptionsItem extends AntdComponent {
/** $props: {
* the label of descriptions item /**
* @type any * the label of descriptions item
*/ * @type any
label: any; */
label?: VNodeChild | JSX.Element;
/** /**
* can be set to small large or omitted * can be set to small large or omitted
* @default 1 * @default 1
* @type number * @type number
*/ */
span: number; span?: number;
};
} }

85
types/descriptions/descriptions.d.ts vendored
View File

@ -2,56 +2,61 @@
// Definitions by: akki-jat <https://github.com/akki-jat> // Definitions by: akki-jat <https://github.com/akki-jat>
// Definitions: https://github.com/vueComponent/ant-design-vue/types // Definitions: https://github.com/vueComponent/ant-design-vue/types
import { VNodeChild } from 'vue';
import { AntdComponent } from '../component'; import { AntdComponent } from '../component';
import { DescriptionsItem } from './descriptions-item'; import { DescriptionsItem } from './descriptions-item';
import { Breakpoint } from '../pub';
export declare class Descriptions extends AntdComponent { export declare class Descriptions extends AntdComponent {
static Item: typeof DescriptionsItem; static Item: typeof DescriptionsItem;
/** $props: {
* descriptions size type /**
* @default 'default' * descriptions size type
* @type string * @default 'default'
*/ * @type string
size: 'default' | 'middle' | 'small'; */
size?: 'default' | 'middle' | 'small';
/** /**
* custom prefixCls * custom prefixCls
* @type string * @type string
*/ */
prefixCls: string; prefixCls?: string;
/** /**
* whether descriptions have border * whether descriptions have border
* @default false * @default false
* @type boolean * @type boolean
*/ */
bordered: boolean; bordered?: boolean;
/** /**
* custom title * custom title
* @type any * @type any
*/ */
title: any; title?: VNodeChild | JSX.Element;
/** /**
* the number of descriptionsitem in one line * the number of descriptionsitem in one line
* @default 3 * @default 3
* @type number | object * @type number | object
*/ */
column: number | object; column?: number | Partial<Breakpoint>;
/** /**
* descriptions layout * descriptions layout
* @default 'horizontal' * @default 'horizontal'
* @type string * @type string
*/ */
layout: 'horizontal' | 'vertical'; layout?: 'horizontal' | 'vertical';
/** /**
* whether have colon in descriptionsitem * whether have colon in descriptionsitem
* @default true * @default true
* @type boolean * @type boolean
*/ */
colon: boolean; colon?: boolean;
};
} }

8
types/pub.ts Normal file
View File

@ -0,0 +1,8 @@
export type Breakpoint = {
xs: number;
sm: number;
md: number;
lg: number;
xl: number;
xxl: number;
};