diff --git a/components/pagination/demo/basic.md b/components/pagination/demo/basic.md new file mode 100644 index 000000000..2f8e1a8a6 --- /dev/null +++ b/components/pagination/demo/basic.md @@ -0,0 +1,26 @@ + + +#### 基本 +基础分页。 + + + +#### Basic +Basic pagination. + + +```html + + +``` + diff --git a/components/pagination/demo/changer.md b/components/pagination/demo/changer.md new file mode 100644 index 000000000..c9da54db6 --- /dev/null +++ b/components/pagination/demo/changer.md @@ -0,0 +1,31 @@ + + +#### 改变 +改变每页显示条目数。 + + + +#### Changer +Change `pageSize`. + + +```html + + + +``` + diff --git a/components/pagination/demo/controlled.md b/components/pagination/demo/controlled.md new file mode 100644 index 000000000..f2ca753e1 --- /dev/null +++ b/components/pagination/demo/controlled.md @@ -0,0 +1,30 @@ + +#### 受控 +受控制的页码。 + + + +#### Controlled +Controlled page number. + + +```html + + +``` + diff --git a/components/pagination/demo/custom-changer.md b/components/pagination/demo/custom-changer.md new file mode 100644 index 000000000..8b99f9174 --- /dev/null +++ b/components/pagination/demo/custom-changer.md @@ -0,0 +1,51 @@ + + +#### 自定义下拉选项 +自定义下拉选项,例如添加全部选项 + + + +#### Custom dropdown options +Customize dropdown options such as adding all options + + +```html + + + +``` + diff --git a/components/pagination/demo/index.vue b/components/pagination/demo/index.vue index 7a6bda42c..b7eedff07 100644 --- a/components/pagination/demo/index.vue +++ b/components/pagination/demo/index.vue @@ -1,88 +1,71 @@ - diff --git a/components/pagination/demo/itemRender.md b/components/pagination/demo/itemRender.md new file mode 100644 index 000000000..3f11314fe --- /dev/null +++ b/components/pagination/demo/itemRender.md @@ -0,0 +1,29 @@ + +#### 上一步和下一步 +修改上一步和下一步为文字链接。 + + + +#### Prev and next +Use text link for prev and next button. + + +```html + + +``` diff --git a/components/pagination/demo/jump.md b/components/pagination/demo/jump.md new file mode 100644 index 000000000..506f165e6 --- /dev/null +++ b/components/pagination/demo/jump.md @@ -0,0 +1,24 @@ + +#### 跳转 +快速跳转到某一页。 + + + +#### Jumper +Jump to a page directly. + + +```html + + +``` diff --git a/components/pagination/demo/mini.md b/components/pagination/demo/mini.md new file mode 100644 index 000000000..f78c979a1 --- /dev/null +++ b/components/pagination/demo/mini.md @@ -0,0 +1,29 @@ + + +#### 迷你 +迷你版本。 + + + +#### Mini size +Mini size pagination. + + +```html + + +``` + diff --git a/components/pagination/demo/more.md b/components/pagination/demo/more.md new file mode 100644 index 000000000..7ccae6d18 --- /dev/null +++ b/components/pagination/demo/more.md @@ -0,0 +1,17 @@ + + +#### 更多 +更多分页。 + + + +#### more +Mode pages. + + +```html + +``` + diff --git a/components/pagination/demo/simple.md b/components/pagination/demo/simple.md new file mode 100644 index 000000000..5417f0df1 --- /dev/null +++ b/components/pagination/demo/simple.md @@ -0,0 +1,17 @@ + + +#### 简洁 +简单的翻页。 + + + +#### Simple mode +Simple mode. + + +```html + +``` + diff --git a/components/pagination/demo/total.md b/components/pagination/demo/total.md new file mode 100644 index 000000000..98f4a49d9 --- /dev/null +++ b/components/pagination/demo/total.md @@ -0,0 +1,31 @@ + + +#### 总数 +通过设置 `showTotal` 展示总共有多少数据。 + + + +#### Total number +You can show the total number of data by setting `showTotal`. + + +```html + +``` + diff --git a/components/pagination/index.en-US.md b/components/pagination/index.en-US.md new file mode 100644 index 000000000..afc0b7ac3 --- /dev/null +++ b/components/pagination/index.en-US.md @@ -0,0 +1,27 @@ +## API + +```html + +``` + +| Property | Description | Type | Default | +| -------- | ----------- | ---- | ------- | +| current | current page number | number | - | +| defaultCurrent | default initial page number | number | 1 | +| defaultPageSize | default number of data items per page | number | 10 | +| hideOnSinglePage | Whether to hide pager on single page | boolean | false | +| itemRender | to customize item innerHTML | (page, type: 'page' \| 'prev' \| 'next', originalElement) => React.ReactNode | - | +| pageSize | number of data items per page | number | - | +| pageSizeOptions | specify the sizeChanger options | string\[] | ['10', '20', '30', '40'] | +| showQuickJumper | determine whether you can jump to pages directly | boolean | false | +| showSizeChanger | determine whether `pageSize` can be changed | boolean | false | +| showTotal | to display the total number and range | Function(total, range) | - | +| simple | whether to use simple mode | boolean | - | +| size | specify the size of `Pagination`, can be set to `small` | string | "" | +| total | total number of data items | number | 0 | + +### events +| Events Name | Description | Arguments | +| --- | --- | --- | +| change | a callback function, executed when the page number is changed, and it takes the resulting page number and pageSize as its arguments | Function(page, pageSize) | noop | +| showSizeChange | a callback function, executed when `pageSize` is changed | Function(current, size) | noop | diff --git a/components/pagination/index.zh-CN.md b/components/pagination/index.zh-CN.md new file mode 100644 index 000000000..b41592912 --- /dev/null +++ b/components/pagination/index.zh-CN.md @@ -0,0 +1,27 @@ +## API + +```html + +``` + +| 参数 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| current(v-model) | 当前页数 | number | - | +| defaultCurrent | 默认的当前页数 | number | 1 | +| defaultPageSize | 默认的每页条数 | number | 10 | +| hideOnSinglePage | 只有一页时是否隐藏分页器 | boolean | false | +| itemRender | 用于自定义页码的结构,可用于优化 SEO | (page, type: 'page' \| 'prev' \| 'next', originalElement) => React.ReactNode | - | +| pageSize | 每页条数 | number | - | +| pageSizeOptions | 指定每页可以显示多少条 | string\[] | ['10', '20', '30', '40'] | +| showQuickJumper | 是否可以快速跳转至某页 | boolean | false | +| showSizeChanger | 是否可以改变 pageSize | boolean | false | +| showTotal | 用于显示数据总量和当前数据顺序 | Function(total, range) | - | +| simple | 当添加该属性时,显示为简单分页 | boolean | - | +| size | 当为「small」时,是小尺寸分页 | string | "" | +| total | 数据总数 | number | 0 | + +### 事件 +| 事件名称 | 说明 | 回调参数 | +| --- | --- | --- | +| change | 页码改变的回调,参数是改变后的页码及每页条数 | Function(page, pageSize) | noop | +| showSizeChange | pageSize 变化的回调 | Function(current, size) | noop | diff --git a/components/steps/demo/customized-progress-dot.md b/components/steps/demo/customized-progress-dot.md index 590b2a8ff..57466d2a1 100644 --- a/components/steps/demo/customized-progress-dot.md +++ b/components/steps/demo/customized-progress-dot.md @@ -10,7 +10,7 @@ You can customize the display for Steps with progress dot style. ```html