Skip to content

Commit 12ce122

Browse files
committed
docs: use <Badge /> to display Readonly
1 parent 8aa7527 commit 12ce122

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/api/field.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,16 @@ Since `validateSync()` is used internally, Async tests are not available.
7171
### `$value` property
7272
- The field value that can be set to `v-model`.
7373

74-
### `$error` property (Readonly)
74+
### `$error` property <Badge type="info" text="Readonly" />
7575
- Returns a result of validating `$value` reactively with the yup schema.
7676
- If `$value` is invalid, `yup.ValidationError` is returned.
7777
- If `$value` is valid, `undefined` is returned.
7878

79-
### `$errorMessages` property (Readonly)
79+
### `$errorMessages` property <Badge type="info" text="Readonly" />
8080
- Returns an error messages array (`string[]`) reactively as well as `$error` property.
8181
- If `abortEarly` is false, it can return more than one element.
8282

83-
### `$label` property (Readonly)
83+
### `$label` property <Badge type="info" text="Readonly" />
8484
- Returns the label of the yup schema.
8585
- For example, if you pass `yup.number().label("Age")`, you will obtain `"Age"`.
8686
- If the `schema` you passed is a function, the function is evaluated once when the object is created.

docs/api/formsField.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,20 @@ function formsField<T extends (arg: any) => Form>(generateForm: T, initialValueL
3030
- Pass `{ abortEarly: false }` if all validation errors by the yup array schema are required.
3131

3232
## Details of `FormsField` object
33-
### `$forms` property (Readonly)
33+
### `$forms` property <Badge type="info" text="Readonly" />
3434
- Returns the array of forms generated by `generateForm`.
3535
- For use with `v-for`, each generated form is given a unique key named `$key`.
3636

37-
### `$error` property (Readonly)
37+
### `$error` property <Badge type="info" text="Readonly" />
3838
- Returns a result of validating `$forms` reactively with the yup schema.
3939
- If `$forms` is invalid, `yup.ValidationError` is returned.
4040
- If `$forms` is valid, `undefined` is returned.
4141

42-
### `$errorMessages` property (Readonly)
42+
### `$errorMessages` property <Badge type="info" text="Readonly" />
4343
- Returns an error messages array (`string[]`) reactively as well as `$error` property.
4444
- If `abortEarly` is false, it can return more than one element.
4545

46-
### `$label` property (Readonly)
46+
### `$label` property <Badge type="info" text="Readonly" />
4747
- Returns the label of the yup schema.
4848
- For example, if you pass `yup.array().label("Questions")`, you will obtain `"Questions"`.
4949
- If the `schema` you passed is a function, the function is evaluated once when the object is created.

0 commit comments

Comments
 (0)