element-plus/website/docs/jp/progress.md

430 lines
12 KiB
Markdown
Raw Normal View History

2020-11-04 10:30:14 +08:00
## 進捗状況
現在の操作の進捗状況を表示し、ユーザーに現在の状態を知らせるために使用されます。
### 線形プログレスバー
:::demo パーセントを設定するには `percentage` 属性を用いる。**必須**で、`0-100`の間で指定する必要があります。`format`を設定することで、テキストの書式をカスタマイズすることができます。
2020-11-04 10:30:14 +08:00
```html
<el-progress :percentage="50"></el-progress>
<el-progress :percentage="100" :format="format"></el-progress>
<el-progress :percentage="100" status="success"></el-progress>
<el-progress :percentage="100" status="warning"></el-progress>
<el-progress :percentage="50" status="exception"></el-progress>
<script>
export default {
methods: {
format(percentage) {
return percentage === 100 ? 'Full' : `${percentage}%`
},
},
}
2020-11-04 10:30:14 +08:00
</script>
<!--
<setup>
import { defineComponent } from 'vue';
export default defineComponent({
setup() {
const format = (percentage) => (percentage === 100 ? 'Full' : `${percentage}%`);
return {
format,
};
},
});
</setup>
-->
2020-11-04 10:30:14 +08:00
```
2020-11-04 10:30:14 +08:00
:::
### 内部比率
この場合、パーセンテージは追加のスペースを取りません。
:::demo `ストローク幅`属性はプログレスバーの幅を決定し、プログレスバーの中に説明を加えるには`text-inside`属性を使う。
2020-11-04 10:30:14 +08:00
```html
<el-progress
:text-inside="true"
:stroke-width="26"
:percentage="70"
></el-progress>
<el-progress
:text-inside="true"
:stroke-width="24"
:percentage="100"
status="success"
></el-progress>
<el-progress
:text-inside="true"
:stroke-width="22"
:percentage="80"
status="warning"
></el-progress>
<el-progress
:text-inside="true"
:stroke-width="20"
:percentage="50"
status="exception"
></el-progress>
2020-11-04 10:30:14 +08:00
```
2020-11-04 10:30:14 +08:00
:::
### カスタムカラー
プログレスバーの色を設定するには `color` attr を使うことができ、色文字列、関数、配列のいずれかを受け付けます。
:::demo
```html
<el-progress :percentage="percentage" :color="customColor"></el-progress>
<el-progress :percentage="percentage" :color="customColorMethod"></el-progress>
<el-progress :percentage="percentage" :color="customColors"></el-progress>
<el-progress :percentage="percentage2" :color="customColors"></el-progress>
2020-11-04 10:30:14 +08:00
<div>
<el-button-group>
<el-button icon="el-icon-minus" @click="decrease"></el-button>
<el-button icon="el-icon-plus" @click="increase"></el-button>
</el-button-group>
</div>
<script>
export default {
data() {
return {
percentage: 20,
percentage2: 0,
2020-11-04 10:30:14 +08:00
customColor: '#409eff',
customColors: [
{ color: '#f56c6c', percentage: 20 },
{ color: '#e6a23c', percentage: 40 },
{ color: '#5cb87a', percentage: 60 },
{ color: '#1989fa', percentage: 80 },
{ color: '#6f7ad3', percentage: 100 },
],
}
2020-11-04 10:30:14 +08:00
},
methods: {
customColorMethod(percentage) {
if (percentage < 30) {
return '#909399'
2020-11-04 10:30:14 +08:00
} else if (percentage < 70) {
return '#e6a23c'
2020-11-04 10:30:14 +08:00
} else {
return '#67c23a'
2020-11-04 10:30:14 +08:00
}
},
increase() {
this.percentage += 10
2020-11-04 10:30:14 +08:00
if (this.percentage > 100) {
this.percentage = 100
2020-11-04 10:30:14 +08:00
}
},
decrease() {
this.percentage -= 10
2020-11-04 10:30:14 +08:00
if (this.percentage < 0) {
this.percentage = 0
2020-11-04 10:30:14 +08:00
}
},
},
mounted() {
setInterval(() => {
this.percentage2 = (this.percentage2 % 100) + 10
}, 500)
},
2020-11-04 10:30:14 +08:00
}
</script>
<!--
<setup>
import { defineComponent, reactive, toRefs } from 'vue';
export default defineComponent({
setup() {
const state = reactive({
percentage: 20,
customColor: '#409eff',
customColors: [
{ color: '#f56c6c', percentage: 20 },
{ color: '#e6a23c', percentage: 40 },
{ color: '#5cb87a', percentage: 60 },
{ color: '#1989fa', percentage: 80 },
{ color: '#6f7ad3', percentage: 100 },
],
});
const customColorMethod = (percentage) => {
if (percentage < 30) {
return '#909399';
} if (percentage < 70) {
return '#e6a23c';
}
return '#67c23a';
};
const increase = () => {
state.percentage += 10;
if (state.percentage > 100) {
state.percentage = 100;
}
};
const decrease = () => {
state.percentage -= 10;
if (state.percentage < 0) {
state.percentage = 0;
}
};
return {
...toRefs(state),
customColorMethod,
increase,
decrease,
};
},
});
</setup>
-->
2020-11-04 10:30:14 +08:00
```
2020-11-04 10:30:14 +08:00
:::
### 円形のプログレスバー
:::demo `type` 属性に `circle` を指定すると円形のプログレスバーが利用でき、`width` 属性を指定すると円形の大きさを変更することができます。
2020-11-04 10:30:14 +08:00
```html
<el-progress type="circle" :percentage="0"></el-progress>
<el-progress type="circle" :percentage="25"></el-progress>
<el-progress type="circle" :percentage="100" status="success"></el-progress>
<el-progress type="circle" :percentage="70" status="warning"></el-progress>
<el-progress type="circle" :percentage="50" status="exception"></el-progress>
```
2020-11-04 10:30:14 +08:00
:::
### ダッシュボードのプログレスバー
`dashboard``type` 属性を指定することでダッシュボードのプログレスバーも利用できる。
:::demo
```html
<el-progress
type="dashboard"
:percentage="percentage"
:color="colors"
></el-progress>
<el-progress
type="dashboard"
:percentage="percentage2"
:color="colors"
></el-progress>
2020-11-04 10:30:14 +08:00
<div>
<el-button-group>
<el-button icon="el-icon-minus" @click="decrease"></el-button>
<el-button icon="el-icon-plus" @click="increase"></el-button>
</el-button-group>
</div>
<script>
export default {
data() {
return {
percentage: 10,
percentage2: 0,
2020-11-04 10:30:14 +08:00
colors: [
{ color: '#f56c6c', percentage: 20 },
{ color: '#e6a23c', percentage: 40 },
{ color: '#5cb87a', percentage: 60 },
{ color: '#1989fa', percentage: 80 },
{ color: '#6f7ad3', percentage: 100 },
],
}
2020-11-04 10:30:14 +08:00
},
methods: {
increase() {
this.percentage += 10
2020-11-04 10:30:14 +08:00
if (this.percentage > 100) {
this.percentage = 100
2020-11-04 10:30:14 +08:00
}
},
decrease() {
this.percentage -= 10
2020-11-04 10:30:14 +08:00
if (this.percentage < 0) {
this.percentage = 0
2020-11-04 10:30:14 +08:00
}
},
},
mounted() {
setInterval(() => {
this.percentage2 = (this.percentage2 % 100) + 10
}, 500)
},
2020-11-04 10:30:14 +08:00
}
</script>
<!--
<setup>
import { defineComponent, reactive, toRefs, onMounted } from 'vue';
export default defineComponent({
setup() {
const state = reactive({
percentage: 10,
percentage2: 0,
colors: [
{ color: '#f56c6c', percentage: 20 },
{ color: '#e6a23c', percentage: 40 },
{ color: '#5cb87a', percentage: 60 },
{ color: '#1989fa', percentage: 80 },
{ color: '#6f7ad3', percentage: 100 },
],
});
const increase = () => {
state.percentage += 10;
if (state.percentage > 100) {
state.percentage = 100;
}
};
const decrease = () => {
state.percentage -= 10;
if (state.percentage < 0) {
state.percentage = 0;
}
};
onMounted(() => {
setInterval(() => {
state.percentage2 = (state.percentage2 % 100) + 10
}, 500)
});
return {
...toRefs(state),
increase,
decrease,
};
},
});
</setup>
-->
2020-11-04 10:30:14 +08:00
```
2020-11-04 10:30:14 +08:00
:::
### Customized content
:::demo Use default slot to add customized content.
```html
<el-progress :percentage="50">
<el-button type="text">Content</el-button>
</el-progress>
<el-progress
:text-inside="true"
:stroke-width="20"
:percentage="50"
status="exception"
>
<span>Content</span>
</el-progress>
<el-progress type="circle" :percentage="100" status="success">
<el-button type="success" icon="el-icon-check" circle></el-button>
</el-progress>
<el-progress type="dashboard" :percentage="80">
<template #default="{ percentage }">
<span class="percentage-value">{{ percentage }}%</span>
<span class="percentage-label">Progressing</span>
</template>
</el-progress>
```
:::
### Indeterminate progress
:::demo Use `indeterminate` attribute to set indeterminate progress, with `duration` to control the animation duration.
```html
<el-progress :percentage="50" :indeterminate="true"></el-progress>
<el-progress
:percentage="100"
:format="format"
:indeterminate="true"
></el-progress>
<el-progress
:percentage="100"
status="success"
:indeterminate="true"
:duration="5"
></el-progress>
<el-progress
:percentage="100"
status="warning"
:indeterminate="true"
:duration="1"
></el-progress>
<el-progress
:percentage="50"
status="exception"
:indeterminate="true"
></el-progress>
<script>
export default {
methods: {
format(percentage) {
return percentage === 100 ? 'Full' : `${percentage}%`
},
},
}
</script>
<!--
<setup>
import { defineComponent } from 'vue';
export default defineComponent({
setup() {
const format = (percentage) => (percentage === 100 ? 'Full' : `${percentage}%`);
return {
format,
};
},
});
</setup>
-->
```
:::
2020-11-04 10:30:14 +08:00
### 属性
| Attribute | Description | Type | Accepted Values | Default |
| -------------- | --------------------------------------------------------------------------------------- | --------------------- | ------------------------- | ------- |
| **percentage** | パーセンテージ、 **required** | number | 0-100 | 0 |
| type | プログレスバーの種類 | string | line/circle/dashboard | line |
| stroke-width | プログレスバーの幅 | number | — | 6 |
| text-inside | パーセントをプログレスバーの中に配置するかどうか、`type`が 'line'の場合のみ動作します。 | boolean | — | false |
| status | プログレスバーの現在の状態 | string | success/exception/warning | — |
| indeterminate | 操作にかかる時間を示しません | boolean | - | false |
| duration | indeterminate のプログレスバーのアニメーション期間 | number | - | 3 |
| color | プログレスバーの背景色を指定します。`status` プロップをオーバーライドします。 | string/function/array | — | '' |
| width | サークルプログレスバーのキャンバス幅 | number | — | 126 |
| show-text | パーセンテージ表示の有無 | boolean | — | true |
| stroke-linecap | 終点でのサークル/ダッシュボード型の形状 | string | butt/round/square | round |
| format | カスタムテキスト形式 | function(percentage) | — | — |
### Slot
| name | Description |
| ------- | ----------------------------------------------- |
| default | Customized content, parameter is { percentage } |