Skip to content

Commit

Permalink
docs: fix table format
Browse files Browse the repository at this point in the history
  • Loading branch information
@wxsms
wxsms committed Dec 10, 2021
1 parent d885db5 commit b32ce77
Show file tree
Hide file tree
Showing 22 changed files with 374 additions and 374 deletions.
20 changes: 10 additions & 10 deletions docs/components/affix.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ Try to scroll the page down and see what's happening to the alert:

#### Props

Name | Type | Default | Required | Description
---------------- | ---------- | ------------ | -------- | -----------------------
`offset` | Number | 0 | | Pixels to offset from screen when calculating position of scroll.
| Name | Type | Default | Required | Description |
|----------|--------|---------|----------|-------------------------------------------------------------------|
| `offset` | Number | 0 | | Pixels to offset from screen when calculating position of scroll. |

#### Slots

Name | Description
--------- | -----------------------
`default` | The affix body.
| Name | Description |
|-----------|-----------------|
| `default` | The affix body. |

#### Events

Name | Description
--------- | -----------------------
`affix` | This event fires immediately before the element has been affixed.
`affixed` | This event is fired after the element has been affixed.
| Name | Description |
|-----------|-------------------------------------------------------------------|
| `affix` | This event fires immediately before the element has been affixed. |
| `affixed` | This event is fired after the element has been affixed. |
22 changes: 11 additions & 11 deletions docs/components/alert.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,20 @@ Use `duration` in milliseconds to auto dismiss alert. It can be used together wi

#### Props

Name | Type | Default | Required | Description
---------------- | ---------- | -------- | -------- | -----------------------
`dismissible` | Boolean | false | | Show dismiss button in alert.
`type` | String | info | | Alert type (success, info, warning, danger).
`duration` | Number | 0 | | Dismiss after milliseconds, use 0 to prevent self-closing.
| Name | Type | Default | Required | Description |
|---------------|---------|---------|----------|------------------------------------------------------------|
| `dismissible` | Boolean | false | | Show dismiss button in alert. |
| `type` | String | info | | Alert type (success, info, warning, danger). |
| `duration` | Number | 0 | | Dismiss after milliseconds, use 0 to prevent self-closing. |

#### Slots

Name | Description
--------- | -----------------------
`default` | The alert body.
| Name | Description |
|-----------|-----------------|
| `default` | The alert body. |

#### Events

Name | Params | Description
----------- | ------ | ---------------
`dismissed` | | Fire after the alert dismissed. Note: you have to hide / destroy the alert using `v-if` / `v-show` / `v-for` manually due to child components can't change state of parent component.
| Name | Params | Description |
|-------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dismissed` | | Fire after the alert dismissed. Note: you have to hide / destroy the alert using `v-if` / `v-show` / `v-for` manually due to child components can't change state of parent component. |
36 changes: 18 additions & 18 deletions docs/components/breadcrumbs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,32 +36,32 @@ Parse `to` (String or Object) instead of `href` will create a `router-link` for

#### Props

Name | Type | Default | Required | Description
---------------- | ---------- | -------- | -------- | -----------------------
`items` | Array | | | Breadcrumb items to create. Props defined in each item object is the same with BreadcrumbItem.vue, except `text` will be replace as the breadcrumb item body.
| Name | Type | Default | Required | Description |
|---------|-------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `items` | Array | | | Breadcrumb items to create. Props defined in each item object is the same with BreadcrumbItem.vue, except `text` will be replace as the breadcrumb item body. |

#### Slots

Name | Description
--------- | -----------------------
`default` | The breadcrumbs body.
| Name | Description |
|-----------|-----------------------|
| `default` | The breadcrumbs body. |

### [BreadcrumbItem](https://github.com/uiv-lib/uiv/blob/1.x/src/components/breadcrumbs/BreadcrumbItem.js)

#### Props

Name | Type | Default | Required | Description
---------------- | ---------- | -------- | -------- | -----------------------
`active` | Boolean | false | | Set item to active state.
`href` | String | | | An native link will be created if this prop present.
`target` | String | | | Native link prop.
`to` | String or Object | | | An Vue-Router link will be created if this prop present.
`replace` | Boolean | false | | Vue-Router link prop.
`append` | Boolean | false | | Vue-Router link prop.
`exact` | Boolean | false | | Vue-Router link prop.
| Name | Type | Default | Required | Description |
|-----------|------------------|---------|----------|----------------------------------------------------------|
| `active` | Boolean | false | | Set item to active state. |
| `href` | String | | | An native link will be created if this prop present. |
| `target` | String | | | Native link prop. |
| `to` | String or Object | | | An Vue-Router link will be created if this prop present. |
| `replace` | Boolean | false | | Vue-Router link prop. |
| `append` | Boolean | false | | Vue-Router link prop. |
| `exact` | Boolean | false | | Vue-Router link prop. |

#### Slots

Name | Description
--------- | -----------------------
`default` | The breadcrumb item body.
| Name | Description |
|-----------|---------------------------|
| `default` | The breadcrumb item body. |
16 changes: 8 additions & 8 deletions docs/components/btn-group.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,17 @@ Due to Bootstrap limitation, `justified` prop on `<btn>` is needed while it is r

#### Props

Name | Type | Default | Required | Description
---------------- | ---------- | -------- | -------- | -----------------------
`size` | String | | | Optional button sizes. Supported: `lg`, `sm`, `xs`.
`vertical` | Boolean | false | | Apply vertical style.
`justified` | Boolean | false | | Apply justified style.
| Name | Type | Default | Required | Description |
|-------------|---------|---------|----------|-----------------------------------------------------|
| `size` | String | | | Optional button sizes. Supported: `lg`, `sm`, `xs`. |
| `vertical` | Boolean | false | | Apply vertical style. |
| `justified` | Boolean | false | | Apply justified style. |

#### Slots

Name | Description
--------- | -----------------------
`default` | The button group body.
| Name | Description |
|-----------|------------------------|
| `default` | The button group body. |

### [BtnToolbar](https://github.com/uiv-lib/uiv/blob/1.x/src/components/button/BtnToolbar.js)

Expand Down
48 changes: 24 additions & 24 deletions docs/components/btn.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,33 +78,33 @@ This needed to work with [`btn-group`](/components/btn-group.html) for correct s

#### Props

Name | Type | Default | Required | Description
---------------- | ---------- | -------- | -------- | -----------------------
`type` | String | default | | Button types in Bootstrap. Supported: `default`, `primary`, `info`, `success`, `warning`, `danger`, `link`.
`native-type` | String | button | | Native button type. Supported: `button`, `submit`, `reset`.
`size` | String | | | Optional button sizes. Supported: `lg`, `sm`, `xs`.
`block` | Boolean | false | | Apply block level style.
`active` | Boolean | false | | Apply active state.
`disabled` | Boolean | false | | Apply disabled state.
`href` | String | | | An native link will be created if this prop present.
`target` | String | | | Native link prop.
`to` | String or Object | | | An Vue-Router link will be created if this prop present.
`replace` | Boolean | false | | Vue-Router link prop.
`append` | Boolean | false | | Vue-Router link prop.
`exact` | Boolean | false | | Vue-Router link prop.
`input-type` | String | | | Use this prop to turn btn to checkbox or radio input. Supported types: `checkbox` / `radio`
`input-value` | | | | The value of input.
`v-model` | | | | The model of input. Note that this prop **is required** if `input-type` present.
`justified` | Boolean | false | | Due to Bootstrap limitation, this prop is needed while using `<btn>` in `<btn-group justified>`. Otherwise it can be ignored.
| Name | Type | Default | Required | Description |
|---------------|------------------|---------|----------|-------------------------------------------------------------------------------------------------------------------------------|
| `type` | String | default | | Button types in Bootstrap. Supported: `default`, `primary`, `info`, `success`, `warning`, `danger`, `link`. |
| `native-type` | String | button | | Native button type. Supported: `button`, `submit`, `reset`. |
| `size` | String | | | Optional button sizes. Supported: `lg`, `sm`, `xs`. |
| `block` | Boolean | false | | Apply block level style. |
| `active` | Boolean | false | | Apply active state. |
| `disabled` | Boolean | false | | Apply disabled state. |
| `href` | String | | | An native link will be created if this prop present. |
| `target` | String | | | Native link prop. |
| `to` | String or Object | | | An Vue-Router link will be created if this prop present. |
| `replace` | Boolean | false | | Vue-Router link prop. |
| `append` | Boolean | false | | Vue-Router link prop. |
| `exact` | Boolean | false | | Vue-Router link prop. |
| `input-type` | String | | | Use this prop to turn btn to checkbox or radio input. Supported types: `checkbox` / `radio` |
| `input-value` | | | | The value of input. |
| `v-model` | | | | The model of input. Note that this prop **is required** if `input-type` present. |
| `justified` | Boolean | false | | Due to Bootstrap limitation, this prop is needed while using `<btn>` in `<btn-group justified>`. Otherwise it can be ignored. |

#### Slots

Name | Description
--------- | -----------------------
`default` | The button body.
| Name | Description |
|-----------|------------------|
| `default` | The button body. |

#### Events

Name | Params | Description
----------- | ------ | ---------------
`click` | | Click event of button / link.
| Name | Params | Description |
|---------|--------|-------------------------------|
| `click` | | Click event of button / link. |
30 changes: 15 additions & 15 deletions docs/components/carousel.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,24 @@ Here is an example using `glyphicon-arrow-left` and `glyphicon-arrow-right`.

#### Props

Name | Type | Default | Required | Description
---------------- | ---------- | --------------------------------- | -------- | -----------------------
`v-model` | Number | | | The current slide index, use this to manual change slide index.
`indicators` | Boolean | true | | Show / hide the indicators.
`controls` | Boolean | true | | Show / hide the controls.
`interval` | Number | 5000 | | Slides running interval time in ms. Use `0` to stop interval.
`icon-control-left` | String | glyphicon glyphicon-chevron-left | | The left control icon font class.
`icon-control-right` | String | glyphicon glyphicon-chevron-right | | The right control icon font class.
| Name | Type | Default | Required | Description |
|----------------------|---------|-----------------------------------|----------|-----------------------------------------------------------------|
| `v-model` | Number | | | The current slide index, use this to manual change slide index. |
| `indicators` | Boolean | true | | Show / hide the indicators. |
| `controls` | Boolean | true | | Show / hide the controls. |
| `interval` | Number | 5000 | | Slides running interval time in ms. Use `0` to stop interval. |
| `icon-control-left` | String | glyphicon glyphicon-chevron-left | | The left control icon font class. |
| `icon-control-right` | String | glyphicon glyphicon-chevron-right | | The right control icon font class. |

#### Slots

Name | Description
--------- | -----------------------
`default` | The carousel body.
`indicators` | Override indicators. This is a scoped slot with `activeIndex` prop and `select` method. See example section above for usage details.
| Name | Description |
|--------------|--------------------------------------------------------------------------------------------------------------------------------------|
| `default` | The carousel body. |
| `indicators` | Override indicators. This is a scoped slot with `activeIndex` prop and `select` method. See example section above for usage details. |

#### Events

Name | Params | Description
----------- | ------ | ---------------
`change` | index | Fire after slide changed, with the index number changed to.
| Name | Params | Description |
|----------|--------|-------------------------------------------------------------|
| `change` | index | Fire after slide changed, with the index number changed to. |

0 comments on commit b32ce77

Please sign in to comment.