進捗

Progress コンポーネントを使用すると、任意のアクティビティの進捗状況を表示できます。


インストール

npx nextui-cli@latest add progress
上記のコマンドは、個別のインストール専用です。もし、 @nextui-org/react がグローバルに既にインストールされている場合は、このステップをスキップしても構いません。

インポート

使用方法

注意: label プロパティが提供されていない場合は、aria-label プロパティを渡すようにしてください。これはアクセシビリティのために必須です。

サイズ

未確定

isIndeterminate プロパティを使用して、未確定のプログレスバーを表示できます。これは、操作にどのくらい時間がかかるかわからない場合に便利です。

ストライプ

ラベル付き

注意: label プロパティを渡す場合は、もはやaria-label プロパティを渡す必要はありません。

値付き

値のフォーマット

値はデフォルトでパーセンテージとしてフォーマットされますが、異なるフォーマットを指定するためにformatOptionsプロパティを使用することで変更できます。formatOptionsは、Intl.NumberFormatのオプションパラメータと互換性があり、現在のロケールに基づいて適用されます。

スロット

  • base: プログレスのベーススロットで、メインコンテナです。
  • labelWrapper: ラベルと値ラベルのラッパーです。
  • label: プログレスのラベルです。
  • value: プログレスの値ラベルです。
  • track: トラックはプログレスの背景バーです。
  • indicator: インジケーターは、valueに従って塗りつぶされるバーです。

カスタムスタイル

カスタム Tailwind CSS クラスをコンポーネントのスロットに渡すことで、Progressコンポーネントをカスタマイズできます。

データ属性

CircularProgressには、base要素に以下の属性があります

  • data-indeterminate: プログレスが不確定かどうかを示します。
  • data-disabled: プログレスが無効かどうかを示します。isDisabledプロパティに基づきます。

アクセシビリティ

  • ARIAを介して、支援技術にプログレスバーとして公開されます。
  • アクセシビリティのためのラベリングサポート。
  • パーセンテージまたは値としての国際化された数値フォーマット。
  • 確定および不確定のプログレスをサポート。
  • aria-valuenowaria-valueminaria-valuemax、およびaria-valuetext属性を公開します。

API

Progress Props

属性説明デフォルト
labelReactNodeラベルとして表示するコンテンツ。-
sizesm | md | lgインジケーターのサイズ。md
colordefault | primary | secondary | success | warning | dangerインジケーターの色。primary
radiusnone | sm | md | lg | fullプログレスのボーダー半径。full
valuenumber現在の値(制御)。-
valueLabelReactNode値のラベルとして表示するコンテンツ(例:4分の1)。-
minValuenumber入力に許可される最小値。0
maxValuenumber入力に許可される最大値。100
formatOptionsIntl.NumberFormat値をフォーマットするためのオプション。{style: 'percent'}
isIndeterminatebooleanプログレスが不確定かどうか。false
isStripedbooleanプログレスがストライプかどうか。false
showValueLabelboolean値ラベルを表示するかどうか。true
isDisabledbooleanプログレスを無効にするかどうか。false
disableAnimationbooleanアニメーションを無効にするかどうか。false
classNamesRecord<"base"|"labelWrapper"|"label"|"track"|"value"|"track"|"indicator", string>プログレススロットにカスタムクラス名を指定できます。-