Skip to content

Commit 6ebc4a1

Browse files
committed
[docs] Add Merger page, replace deprecated methods
1 parent 26a1f69 commit 6ebc4a1

File tree

8 files changed

+37
-8
lines changed

8 files changed

+37
-8
lines changed

.changeset/eleven-experts-bathe.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"docs": patch
3+
---
4+
5+
Add `Merger` page, replace deprecated methods

apps/docs/src/content/docs/advanced/form-base.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@ You should calculate initial value by yourself.
3434

3535
```svelte
3636
<script lang="ts">
37-
import { FormBase, getDefaultFormState } from "@sjsf/form";
37+
import { FormBase } from "@sjsf/form";
3838
import { translation } from "@sjsf/form/translations/en";
3939
import { theme } from "@sjsf/form/basic-theme";
40+
import { getDefaultFormState } from '@sjsf/form/get-default-form-state';
4041
4142
import { schema, uiSchema, initialData } from "./schema";
4243
import { validator } from "./validator";

apps/docs/src/content/docs/advanced/state-transformation.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,26 +25,28 @@ It will be replaced with `@sjsf/form/omit-extra-data` import in the major releas
2525

2626
```svelte
2727
<script lang="ts">
28-
import { Form } from "@sjsf/form";
28+
import { Form, DefaultMerger } from "@sjsf/form";
2929
import { translation } from "@sjsf/form/translations/en";
3030
import { theme } from "@sjsf/form/basic-theme";
31-
import { omitExtraData } from "@sjsf/form/legacy-omit-extra-data";
31+
import { omitExtraData2 } from "@sjsf/form/legacy-omit-extra-data";
3232
3333
import { schema, uiSchema, initialData } from "./schema";
3434
import { validator } from "./validator";
3535
import { transform } from "./transform";
3636
37+
const merger = new DefaultMerger(validator, schema);
3738
let value = $state();
3839
</script>
3940
4041
<Form
4142
bind:value
4243
{...theme}
44+
{merger}
4345
{schema}
4446
{uiSchema}
4547
{validator}
4648
{translation}
47-
getSnapshot={() => omitExtraData(validator, schema, $state.snapshot(value))}
49+
getSnapshot={() => omitExtraData2(validator, merger, schema, $state.snapshot(value))}
4850
onSubmit={(value) => {
4951
console.log("transformed", value);
5052
}}

apps/docs/src/content/docs/api-reference/handlers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Handlers
33
sidebar:
4-
order: 9
4+
order: 10
55
---
66

77
```typescript

apps/docs/src/content/docs/api-reference/icons.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Icons
33
sidebar:
4-
order: 11
4+
order: 12
55
---
66

77
```typescript

apps/docs/src/content/docs/api-reference/inputs-validation-mode.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Inputs validation mode
33
sidebar:
4-
order: 10
4+
order: 11
55
---
66

77
```typescript
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Merger
3+
sidebar:
4+
order: 8
5+
---
6+
7+
```typescript
8+
export interface Merger {
9+
/**
10+
* Merges schema and its `allOf` schemas into a single schema
11+
*/
12+
mergeAllOf(schema: Schema): Schema;
13+
/**
14+
* Merges defaults of `schema` into `formData`
15+
*/
16+
mergeFormDataAndSchemaDefaults(
17+
formData: SchemaValue | undefined,
18+
schema: Schema
19+
): SchemaValue | undefined;
20+
}
21+
```

apps/docs/src/content/docs/api-reference/translation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Translation
33
sidebar:
4-
order: 8
4+
order: 9
55
---
66

77
## Labels list

0 commit comments

Comments
 (0)