コンテンツにスキップ

useChangeCase

カテゴリ
エクスポートサイズ
385 B
パッケージ
@vueuse/integrations
最終変更日
先週

change-caseのリアクティブなラッパーです。

useCamelCaseusePascalCaseuseSnakeCaseuseSentenceCaseuseCapitalizeなどを置き換えます。

デモ

helloWorld
@vueuse/integrations アドオンで利用可能です。

インストール

bash
npm i change-case@^5

使用方法

ts
import { useChangeCase } from '@vueuse/integrations/useChangeCase'

// `changeCase` will be a computed
const changeCase = useChangeCase('hello world', 'camelCase')
changeCase.value // helloWorld
changeCase.value = 'vue use'
changeCase.value // vueUse
// Supported methods
// export {
//   camelCase,
//   capitalCase,
//   constantCase,
//   dotCase,
//   headerCase,
//   noCase,
//   paramCase,
//   pascalCase,
//   pathCase,
//   sentenceCase,
//   snakeCase,
// } from 'change-case'

またはrefを渡すと、返されるcomputedはソースrefの変更とともに変更されます。

カスタマイズのためにoptionsに渡すことができます

ts
import { useChangeCase } from '@vueuse/integrations/useChangeCase'
import { ref } from 'vue'

const input = ref('helloWorld')
const changeCase = useChangeCase(input, 'camelCase', {
  delimiter: '-',
})
changeCase.value // hello-World
ref.value = 'vue use'
changeCase.value // vue-Use

型宣言

typescript
type EndsWithCase<T> = T extends `${infer _}Case` ? T : never
type FilterKeys<T> = {
  [K in keyof T as K extends string ? K : never]: EndsWithCase<K>
}
type ChangeCaseKeys = FilterKeys<typeof changeCase>
export type ChangeCaseType = ChangeCaseKeys[keyof ChangeCaseKeys]
export declare function useChangeCase(
  input: MaybeRef<string>,
  type: MaybeRefOrGetter<ChangeCaseType>,
  options?: MaybeRefOrGetter<Options> | undefined,
): WritableComputedRef<string>
export declare function useChangeCase(
  input: MaybeRefOrGetter<string>,
  type: MaybeRefOrGetter<ChangeCaseType>,
  options?: MaybeRefOrGetter<Options> | undefined,
): ComputedRef<string>

ソース

ソースデモドキュメント

貢献者

Anthony Fu
Anthony Fu
David Vallejo
wheat
Doctorwu
丶远方
Toni Engelhardt
sun0day
Curt Grimes
马灿

変更履歴

v12.0.0-beta.1 2024/11/21
0a9ed - feat!: Vue 2 サポートの削除、バンドルの最適化、クリーンアップ (#4349)
v11.0.0-beta.3 2024/8/14
5c598 - fix: フィルターにエクスポートされたキーを使用する (#4130)
v11.0.0-beta.1 2024/6/12
df343 - feat!: change-case@v5 に移行し、#3457 をクローズする (#3460)
v10.0.0-beta.5 2023年4月13日
cb644 - リファクタリング!: isFunction および isString ユーティリティの削除
v10.0.0-beta.4 2023年4月13日
4d757 - 機能(types)!: MaybeComputedRefMaybeRefOrGetter に名称変更
0a72b - 機能(toValue): resolveUnreftoValue に名称変更

MITライセンスの下でリリースされています。