@fibrae/semi-ui-svelte 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/dist/components/form/form.svelte +3 -1
  2. package/dist/components/form/index.d.ts +4 -2
  3. package/dist/components/form/index.js +3 -1
  4. package/dist/components/form/interface.d.ts +57 -10
  5. package/dist/components/form/label.svelte +37 -13
  6. package/dist/components/form/schema-form/schema-field.svelte +4 -6
  7. package/dist/components/form/schema-form/schema-form.svelte +2 -2
  8. package/dist/components/form/schema-form/schema-node.svelte +73 -91
  9. package/dist/components/form/schema-form/schema-node.svelte.d.ts +2 -3
  10. package/dist/components/form/schema-form/semi-array.svelte +47 -0
  11. package/dist/components/form/schema-form/semi-array.svelte.d.ts +7 -0
  12. package/dist/components/form/schema-form/semi-field.svelte +42 -0
  13. package/dist/components/form/schema-form/semi-field.svelte.d.ts +8 -0
  14. package/dist/components/form/schema-form/semi-renderers.svelte +24 -0
  15. package/dist/components/form/schema-form/semi-renderers.svelte.d.ts +24 -0
  16. package/dist/components/form/schema-form/semi-section.svelte +22 -0
  17. package/dist/components/form/schema-form/semi-section.svelte.d.ts +10 -0
  18. package/dist/components/form/section.svelte +8 -2
  19. package/dist/components/spin/icon.svelte +1 -1
  20. package/dist/components/table/body/body.svelte +21 -8
  21. package/dist/components/table/table-header/table-header-row.svelte +13 -2
  22. package/dist/components/table/table.svelte +31 -5
  23. package/dist/internal/virtual-list.svelte +11 -1
  24. package/dist/internal/virtual-list.svelte.d.ts +7 -0
  25. package/dist/styles.css +1 -1
  26. package/package.json +3 -3
@@ -3,7 +3,7 @@
3
3
  import { cssClasses } from '@fibrae/semi-foundation/components/form/constants';
4
4
  import { getFormApiProxyInternals } from '@fibrae/semi-foundation/components/form/form-api-proxy';
5
5
  import FormFoundation from '@fibrae/semi-foundation/components/form/foundation';
6
- import type { BaseFormAdapter, FormFoundationState, FormState } from '@fibrae/semi-foundation/components/form/interface';
6
+ import type { BaseFormAdapter, FieldPath, FormFoundationState, FormState } from '@fibrae/semi-foundation/components/form/interface';
7
7
  import '@fibrae/semi-foundation/components/form/form.css';
8
8
  import { useDefaultProps, useFoundation } from '../../base/index.js';
9
9
  import useLocale from '../locale/use-locale.svelte.js';
@@ -43,6 +43,7 @@
43
43
  onChange,
44
44
  onValueChange,
45
45
  onErrorChange,
46
+ onRevealField,
46
47
  getFormApi: notifyFormApi,
47
48
  children,
48
49
  ...rest
@@ -132,6 +133,7 @@
132
133
  notifyValueChange: (values, changedValues) => onValueChange?.(values, changedValues),
133
134
  notifyErrorChange: (errors, changedError) => onErrorChange?.(errors, changedError),
134
135
  notifyReset: () => onReset?.(),
136
+ notifyRevealField: (field) => onRevealField?.(field as FieldPath<Values>),
135
137
  getFormElement: () => formElement ?? null,
136
138
  })
137
139
  );
@@ -27,8 +27,10 @@ import FormInputGroup from './input-group.svelte';
27
27
  import FormLabel from './label.svelte';
28
28
  import SchemaField from './schema-form/schema-field.svelte';
29
29
  import SchemaForm from './schema-form/schema-form.svelte';
30
+ import { semiRenderers } from './schema-form/semi-renderers.svelte';
30
31
  import FormSection from './section.svelte';
31
32
  import FormSlot from './slot.svelte';
32
- export { ArrayField, Form, FormAutoComplete, FormCascader, FormCheckbox, FormCheckboxGroup, FormDatePicker, FormErrorMessage, FormField, FormInput, FormInputGroup, FormInputNumber, FormLabel, FormPinCode, FormRadio, FormRadioGroup, FormRating, FormSection, FormSelect, FormSlider, FormSlot, FormSwitch, FormTagInput, FormTextArea, FormTimePicker, FormTransfer, FormTreeSelect, FormUpload, SchemaField, SchemaForm, useForm, };
33
+ export { ArrayField, Form, FormAutoComplete, FormCascader, FormCheckbox, FormCheckboxGroup, FormDatePicker, FormErrorMessage, FormField, FormInput, FormInputGroup, FormInputNumber, FormLabel, FormPinCode, FormRadio, FormRadioGroup, FormRating, FormSection, FormSelect, FormSlider, FormSlot, FormSwitch, FormTagInput, FormTextArea, FormTimePicker, FormTransfer, FormTreeSelect, FormUpload, SchemaField, SchemaForm, semiRenderers, useForm, };
34
+ export { blankRow } from '@fibrae/semi-foundation/components/form/json-schema';
33
35
  export { useFieldApi, useFieldState, useFormApi, useFormState } from './hooks/index.js';
34
- export type { ArrayFieldItem, ArrayFieldProps, ArrayFieldSnippetProps, CommonFieldProps, ErrorMessageProps as FormErrorMessageProps, FieldError, FieldErrorInput, FieldLabel, FieldProps, FieldValidateTriggerType, FieldValidator, FormApi, FormFieldProps, FormProps, FormRenderProps, FormState, FormValidator, InputGroupProps as FormInputGroupProps, JsonSchema, LabelProps as FormLabelProps, OptionalFieldProps, RuleItem, RuleType, SchemaFieldKind, SchemaFieldNode, SchemaFieldProps, SchemaFieldRenderProps, SchemaFormProps, ScrollOptions, SectionProps as FormSectionProps, SlotProps as FormSlotProps, WithFieldOption, } from './interface.js';
36
+ export type { ArrayFieldItem, ArrayFieldProps, ArrayFieldSnippetProps, CommonFieldProps, ErrorMessageProps as FormErrorMessageProps, FieldError, FieldErrorInput, FieldLabel, FieldProps, FieldValidateTriggerType, FieldValidator, FormApi, FormFieldProps, FormProps, FormRenderProps, FormState, FormValidator, InputGroupProps as FormInputGroupProps, JsonSchema, LabelProps as FormLabelProps, OptionalFieldProps, RuleItem, RuleType, SchemaArrayContext, SchemaArrayItem, SchemaFieldContext, SchemaFieldKind, SchemaFieldNode, SchemaFieldProps, SchemaFieldRenderers, SchemaFormProps, SchemaLeafContext, SchemaObjectContext, ScrollOptions, SectionProps as FormSectionProps, SlotProps as FormSlotProps, WithFieldOption, } from './interface.js';
@@ -27,7 +27,9 @@ import FormInputGroup from './input-group.svelte';
27
27
  import FormLabel from './label.svelte';
28
28
  import SchemaField from './schema-form/schema-field.svelte';
29
29
  import SchemaForm from './schema-form/schema-form.svelte';
30
+ import { semiRenderers } from './schema-form/semi-renderers.svelte';
30
31
  import FormSection from './section.svelte';
31
32
  import FormSlot from './slot.svelte';
32
- export { ArrayField, Form, FormAutoComplete, FormCascader, FormCheckbox, FormCheckboxGroup, FormDatePicker, FormErrorMessage, FormField, FormInput, FormInputGroup, FormInputNumber, FormLabel, FormPinCode, FormRadio, FormRadioGroup, FormRating, FormSection, FormSelect, FormSlider, FormSlot, FormSwitch, FormTagInput, FormTextArea, FormTimePicker, FormTransfer, FormTreeSelect, FormUpload, SchemaField, SchemaForm, useForm, };
33
+ export { ArrayField, Form, FormAutoComplete, FormCascader, FormCheckbox, FormCheckboxGroup, FormDatePicker, FormErrorMessage, FormField, FormInput, FormInputGroup, FormInputNumber, FormLabel, FormPinCode, FormRadio, FormRadioGroup, FormRating, FormSection, FormSelect, FormSlider, FormSlot, FormSwitch, FormTagInput, FormTextArea, FormTimePicker, FormTransfer, FormTreeSelect, FormUpload, SchemaField, SchemaForm, semiRenderers, useForm, };
34
+ export { blankRow } from '@fibrae/semi-foundation/components/form/json-schema';
33
35
  export { useFieldApi, useFieldState, useFormApi, useFormState } from './hooks/index.js';
@@ -3,7 +3,7 @@ import type { HTMLAttributes, HTMLFieldsetAttributes, HTMLFormAttributes, HTMLLa
3
3
  import type { Options as ScrollIntoViewOptions } from 'scroll-into-view-if-needed';
4
4
  import type { FieldError } from '@fibrae/semi-foundation/components/form/errors';
5
5
  import type { AllErrors, BaseFormApi, DeepPartial, ExclusiveFieldValidation, ExclusiveFormValidation, FieldPath, FieldValidateTriggerType, FieldValidator, FormState, FormValidator, StandardSchema } from '@fibrae/semi-foundation/components/form/interface';
6
- import type { JsonSchema, SchemaFieldNode } from '@fibrae/semi-foundation/components/form/json-schema';
6
+ import type { arrayState, JsonSchema, SchemaFieldNode } from '@fibrae/semi-foundation/components/form/json-schema';
7
7
  import type { RuleItem } from '@fibrae/semi-foundation/components/form/rules';
8
8
  import type { ColProps } from '../grid/interface.js';
9
9
  import type { InputGroupProps as BaseInputGroupProps, ValidateStatus } from '../input/interface.js';
@@ -27,9 +27,13 @@ export interface LabelProps extends Omit<HTMLLabelAttributes, 'children'> {
27
27
  width?: number | string;
28
28
  children?: Snippet;
29
29
  extra?: Snippet;
30
+ /** Shown in a Tooltip by a help button beside the label, which is not part of the field's name */
31
+ tooltip?: Snippet | string | number;
30
32
  }
31
33
  /** A label configured by data; nodes go in the `fieldLabel` and `labelExtra` snippets */
32
34
  export interface FieldLabel {
35
+ /** Shown in a Tooltip by a help button beside the label, which is not part of the field's name */
36
+ tooltip?: string | number;
33
37
  /** The id of the label element, which the control's aria-labelledby references; generated when missing */
34
38
  id?: string;
35
39
  text?: string | number;
@@ -85,6 +89,8 @@ export interface AllFormProps<Values extends Record<string, any> = any, Output =
85
89
  onChange?: (formState: FormState<Values>) => void;
86
90
  onValueChange?: (values: Values, changedValues: Partial<Values>) => void;
87
91
  onErrorChange?: (errors: AllErrors<Values>, changedError?: Partial<Record<FieldPath<Values>, FieldError>>) => void;
92
+ /** scrollToField or focusField found nothing rendered at `field`: expand the collapsed container that holds it */
93
+ onRevealField?: (field: FieldPath<Values>) => void;
88
94
  /** Called once when the Form mounts, to save the formApi reference */
89
95
  getFormApi?: (formApi: FormApi<Values, Output>) => void;
90
96
  children?: Snippet<[FormRenderProps<Values, Output>]>;
@@ -222,6 +228,8 @@ export interface ErrorMessageProps extends Omit<HTMLAttributes<HTMLDivElement>,
222
228
  }
223
229
  export interface SectionProps extends Omit<HTMLFieldsetAttributes, 'children'> {
224
230
  text?: Snippet;
231
+ /** Shown below the title and describes the fieldset */
232
+ extraText?: Snippet;
225
233
  children?: Snippet;
226
234
  }
227
235
  export interface SlotProps extends Omit<HTMLAttributes<HTMLDivElement>, 'children'> {
@@ -243,21 +251,60 @@ export interface InputGroupProps extends Omit<BaseInputGroupProps, 'label'> {
243
251
  extraTextPosition?: 'bottom' | 'middle';
244
252
  extraText?: Snippet;
245
253
  }
246
- export interface SchemaFieldRenderProps {
254
+ interface SchemaNodeContext {
247
255
  node: SchemaFieldNode;
256
+ /** Renders the node at `field` through the same renderers; key the result when rendering a list */
257
+ render: Snippet<[string]>;
258
+ }
259
+ export interface SchemaObjectContext extends SchemaNodeContext {
260
+ kind: 'object';
261
+ /** The property nodes rendered in schema order */
262
+ content: Snippet;
263
+ }
264
+ export interface SchemaArrayItem {
265
+ /** Stable across moves: key the row with it, not with `index` */
266
+ key: string;
248
267
  field: string;
268
+ index: number;
269
+ node: SchemaFieldNode;
270
+ /** The row's current value, such as the field a card title reads */
271
+ value: unknown;
272
+ remove: () => void;
273
+ }
274
+ export interface SchemaArrayContext extends SchemaNodeContext, ReturnType<typeof arrayState> {
275
+ kind: 'array';
276
+ items: SchemaArrayItem[];
277
+ /** Inserts the schema's blank row before `index`, or appends it; an event argument counts as no index */
278
+ add: (index?: number | Event) => void;
279
+ addWithInitValue: (value: Record<string, any>, index?: number) => void;
280
+ move: (from: number, to: number) => void;
281
+ /** The error of the array itself (a schema's minItems), not those of its rows */
282
+ error?: FieldError;
283
+ /** Spread on the element that contains the rows, so scrollToField and focusField reach the array */
284
+ fieldProps: {
285
+ 'x-field-id': string;
286
+ };
287
+ }
288
+ /** Any node that is neither an object nor an array: `node.item` is set when it is a row of an array */
289
+ export interface SchemaLeafContext extends SchemaNodeContext {
290
+ kind: 'field';
291
+ }
292
+ export type SchemaFieldContext = SchemaObjectContext | SchemaArrayContext | SchemaLeafContext;
293
+ export interface SchemaFieldRenderers {
294
+ /** Without it an object renders its properties with no wrapper */
295
+ object?: Snippet<[SchemaObjectContext]>;
296
+ array?: Snippet<[SchemaArrayContext]>;
297
+ /** Also receives the nodes of kind `unsupported` */
298
+ field?: Snippet<[SchemaLeafContext]>;
249
299
  }
250
300
  export interface SchemaFieldProps {
251
- /** Path of the node to render; the root by default, which renders without a Section */
301
+ /** Path of the node to render; '' is the root */
252
302
  field?: string;
253
303
  /** Takes precedence over the JSON Schema exported from the Form's `schema` */
254
304
  jsonSchema?: JsonSchema;
255
- /**
256
- * Field components by `format`, then by kind (`input`, `number`, `select` ...); they receive the props of the built-in
257
- * control they replace
258
- */
259
- widgets?: Record<string, Component<any, any, any>>;
260
- /** Snippets by node pattern (`contacts[].email`); one renders the node and everything under it */
261
- renderField?: Record<string, Snippet<[SchemaFieldRenderProps]>>;
305
+ /** How each kind of node renders; SchemaField itself renders no UI. `semiRenderers` renders Semi Form controls */
306
+ renderers?: SchemaFieldRenderers;
307
+ /** Replaces the renderer of the node whose `pattern` (array rows as `[]`) is the key */
308
+ renderField?: Record<string, Snippet<[SchemaFieldContext]>>;
262
309
  }
263
310
  export type SchemaFormProps<Values extends Record<string, any> = any, Output = Values> = FormProps<Values, Output> & Omit<SchemaFieldProps, 'field'>;
@@ -2,27 +2,51 @@
2
2
  import { cssClasses } from '@fibrae/semi-foundation/components/form/constants';
3
3
  import { toCssLength } from '@fibrae/semi-foundation/utils';
4
4
  import '@fibrae/semi-foundation/components/form/form.css';
5
+ import { IconHelpCircle } from '@fibrae/semi-icons-svelte';
5
6
  import useLocale from '../locale/use-locale.svelte.js';
7
+ import type { TooltipTriggerProps } from '../tooltip/interface.js';
8
+ import Tooltip from '../tooltip/tooltip.svelte';
6
9
  import type { LabelProps } from './interface.js';
7
10
 
8
- let { text, align = 'left', disabled, required = false, optional = false, name, width, children, extra, ...rest }: LabelProps = $props();
11
+ let { text, align = 'left', disabled, required = false, optional = false, name, width, children, extra, tooltip, ...rest }: LabelProps = $props();
9
12
 
10
13
  const locale = useLocale('Form');
11
14
 
12
15
  const prefix = `${cssClasses.PREFIX}-field-label`;
13
16
  const hasExtra = $derived(Boolean(extra));
17
+ const hasTooltip = $derived(tooltip !== undefined && tooltip !== '');
14
18
  </script>
15
19
 
16
- <label
17
- {...rest}
18
- class={[prefix, rest.class, { [`${prefix}-left`]: align === 'left', [`${prefix}-right`]: align === 'right', [`${prefix}-required`]: required && !optional, [`${prefix}-disabled`]: disabled, [`${prefix}-with-extra`]: hasExtra }]}
19
- for={name || rest.for || undefined}
20
- style={[rest.style, width !== undefined && `width: ${toCssLength(width)}`].filter(Boolean).join(';') || undefined}
21
- >
22
- <div class={`${prefix}-text`} x-semi-prop="label">
23
- {#if children}{@render children()}{:else}{text}{/if}{#if optional}<span class={`${prefix}-optional-text`}>{locale().locale.optional}</span>{/if}
20
+ {#snippet labelView()}
21
+ <label
22
+ {...rest}
23
+ class={[prefix, rest.class, { [`${prefix}-left`]: align === 'left', [`${prefix}-right`]: align === 'right', [`${prefix}-required`]: required && !optional, [`${prefix}-disabled`]: disabled, [`${prefix}-with-extra`]: hasExtra }]}
24
+ for={name || rest.for || undefined}
25
+ style={[rest.style, width !== undefined && !hasTooltip && `width: ${toCssLength(width)}`].filter(Boolean).join(';') || undefined}
26
+ >
27
+ <div class={`${prefix}-text`} x-semi-prop="label">
28
+ {#if children}{@render children()}{:else}{text}{/if}{#if optional}<span class={`${prefix}-optional-text`}>{locale().locale.optional}</span>{/if}
29
+ </div>
30
+ {#if hasExtra}
31
+ <div class={`${prefix}-extra`}>{@render extra?.()}</div>
32
+ {/if}
33
+ </label>
34
+ {/snippet}
35
+
36
+ {#snippet tooltipButton(triggerProps: Partial<TooltipTriggerProps>)}
37
+ <button {...triggerProps} aria-label={locale().locale.labelTooltip} class={`${prefix}-tooltip`} type="button">
38
+ <IconHelpCircle />
39
+ </button>
40
+ {/snippet}
41
+
42
+ {#if hasTooltip}
43
+ <div class={`${prefix}-with-tooltip`} style={width === undefined ? undefined : `width: ${toCssLength(width)}`}>
44
+ {@render labelView()}
45
+ <Tooltip>
46
+ {#snippet child({ props })}{@render tooltipButton(props)}{/snippet}
47
+ {#snippet content()}{#if typeof tooltip === 'function'}{@render tooltip()}{:else}{tooltip}{/if}{/snippet}
48
+ </Tooltip>
24
49
  </div>
25
- {#if hasExtra}
26
- <div class={`${prefix}-extra`}>{@render extra?.()}</div>
27
- {/if}
28
- </label>
50
+ {:else}
51
+ {@render labelView()}
52
+ {/if}
@@ -1,6 +1,5 @@
1
1
  <script lang="ts">
2
- import { untrack } from 'svelte';
3
- import { describeSchemaField, resolveJsonSchema } from '@fibrae/semi-foundation/components/form/json-schema';
2
+ import { describeSchemaField, resolveJsonSchema, schemaFieldWarnings } from '@fibrae/semi-foundation/components/form/json-schema';
4
3
  import { warning } from '@fibrae/semi-foundation/utils';
5
4
  import { useDefaultProps } from '../../../base/index.js';
6
5
  import { getFormContext } from '../context.js';
@@ -8,7 +7,7 @@
8
7
  import SchemaNode from './schema-node.svelte';
9
8
 
10
9
  const defaults = useDefaultProps('SchemaField');
11
- let { field = defaults('field', ''), jsonSchema = defaults('jsonSchema'), widgets = defaults('widgets'), renderField = defaults('renderField') }: SchemaFieldProps = $props();
10
+ let { field = defaults('field', ''), jsonSchema = defaults('jsonSchema'), renderers = defaults('renderers'), renderField = defaults('renderField') }: SchemaFieldProps = $props();
12
11
 
13
12
  const form = getFormContext();
14
13
 
@@ -21,11 +20,10 @@
21
20
  const node = $derived(root && describeSchemaField(root, field));
22
21
 
23
22
  $effect(() => {
24
- const missing = !root;
25
- untrack(() => warning(missing, '[Semi Form] SchemaField has no JSON Schema to render: pass jsonSchema, or give the Form a schema that exports one'));
23
+ warning(!root, schemaFieldWarnings.noSchema);
26
24
  });
27
25
  </script>
28
26
 
29
27
  {#if root && node}
30
- <SchemaNode {node} {renderField} {root} {widgets} />
28
+ <SchemaNode {node} {renderField} {renderers} {root} />
31
29
  {/if}
@@ -5,7 +5,7 @@
5
5
  import SchemaField from './schema-field.svelte';
6
6
 
7
7
  const defaults = useDefaultProps('SchemaForm');
8
- let { jsonSchema = defaults('jsonSchema'), widgets = defaults('widgets'), renderField = defaults('renderField'), children: content, ...rest }: SchemaFormProps<Values, Output> = $props();
8
+ let { jsonSchema = defaults('jsonSchema'), renderers = defaults('renderers'), renderField = defaults('renderField'), children: content, ...rest }: SchemaFormProps<Values, Output> = $props();
9
9
 
10
10
  let form = $state.raw<{ getFormApi: () => FormApi<Values, Output> }>();
11
11
 
@@ -16,7 +16,7 @@
16
16
 
17
17
  <Form bind:this={form} {...rest}>
18
18
  {#snippet children(renderProps)}
19
- <SchemaField {jsonSchema} {renderField} {widgets} />
19
+ <SchemaField {jsonSchema} {renderField} {renderers} />
20
20
  {@render content?.(renderProps)}
21
21
  {/snippet}
22
22
  </Form>
@@ -1,116 +1,98 @@
1
1
  <script lang="ts">
2
- import { type Component, untrack } from 'svelte';
3
- import { cssClasses } from '@fibrae/semi-foundation/components/form/constants';
4
- import { blankRow, describeSchemaField, type JsonSchema, type SchemaFieldKind, type SchemaFieldNode } from '@fibrae/semi-foundation/components/form/json-schema';
5
- import { formatLocale } from '@fibrae/semi-foundation/locale';
2
+ import type { Snippet } from 'svelte';
3
+ import { get } from 'es-toolkit/compat';
4
+ import { isErrorLeaf } from '@fibrae/semi-foundation/components/form/errors';
5
+ import { arrayState, blankRow, describeSchemaField, schemaFieldWarnings, type JsonSchema, type SchemaFieldNode } from '@fibrae/semi-foundation/components/form/json-schema';
6
6
  import { warning } from '@fibrae/semi-foundation/utils';
7
- import { IconArrowDown, IconArrowUp, IconDelete, IconPlus } from '@fibrae/semi-icons-svelte';
8
- import Button from '../../button/button.svelte';
9
- import useLocale from '../../locale/use-locale.svelte.js';
10
7
  import ArrayField from '../array-field.svelte';
11
- import FormInputNumber from '../fields/form-input-number.svelte';
12
- import FormInput from '../fields/form-input.svelte';
13
- import FormSelect from '../fields/form-select.svelte';
14
- import FormSwitch from '../fields/form-switch.svelte';
15
- import FormTextArea from '../fields/form-text-area.svelte';
16
- import type { SchemaFieldProps } from '../interface.js';
17
- import FormSection from '../section.svelte';
8
+ import { getFormContext } from '../context.js';
9
+ import type { ArrayFieldSnippetProps, SchemaArrayContext, SchemaFieldContext, SchemaFieldProps, SchemaLeafContext, SchemaObjectContext } from '../interface.js';
18
10
  import SchemaNode from './schema-node.svelte';
19
11
 
20
- interface SchemaNodeProps extends Pick<SchemaFieldProps, 'widgets' | 'renderField'> {
12
+ interface SchemaNodeProps extends Pick<SchemaFieldProps, 'renderers' | 'renderField'> {
21
13
  root: JsonSchema;
22
14
  node: SchemaFieldNode;
23
15
  }
24
16
 
25
- let { root, node, widgets, renderField }: SchemaNodeProps = $props();
17
+ let { root, node, renderers, renderField }: SchemaNodeProps = $props();
26
18
 
27
- const locale = useLocale('Form');
19
+ const form = getFormContext();
28
20
 
29
- const rowClass = `${cssClasses.PREFIX}-schema-array-row`;
30
- const builtins: Partial<Record<SchemaFieldKind, Component<any, any, any>>> = { input: FormInput, textarea: FormTextArea, number: FormInputNumber, switch: FormSwitch, select: FormSelect };
31
- const renderer = $derived(renderField?.[node.pattern]);
32
- const Control = $derived((node.format !== undefined && widgets?.[node.format]) || widgets?.[node.kind] || builtins[node.kind]);
33
- const label = $derived({ text: node.title ?? itemText('item', Number(node.key)), required: node.required });
21
+ if (!form) {
22
+ throw new Error('[Semi Form] SchemaField must be used inside <Form>');
23
+ }
34
24
 
35
- const controlProps = $derived.by((): Record<string, unknown> => {
36
- switch (node.kind) {
37
- case 'input':
38
- return { maxLength: node.maxLength };
39
- case 'textarea':
40
- return { maxCount: node.maxLength };
41
- case 'number':
42
- return { min: node.minimum, max: node.maximum, precision: node.integer ? 0 : undefined };
43
- case 'select':
44
- return { optionList: node.options, multiple: node.multiple };
45
- default:
46
- return {};
47
- }
48
- });
25
+ const rendererKind = $derived(node.kind === 'object' || node.kind === 'array' ? node.kind : 'field');
26
+ const renderer = $derived((renderField?.[node.pattern] ?? renderers?.[rendererKind]) as Snippet<[SchemaFieldContext]> | undefined);
27
+ const objectContext = $derived<SchemaObjectContext>({ kind: 'object', node, render, content });
28
+ const leafContext = $derived<SchemaLeafContext>({ kind: 'field', node, render });
49
29
 
50
- function itemText(key: 'item' | 'removeItem' | 'moveUpItem' | 'moveDownItem', index: number) {
51
- return formatLocale(locale().locale[key], { index: index + 1 });
52
- }
30
+ // A getter reads the form state where the renderer uses it, so typing in a row does not rebuild the context
31
+ const arrayContext = ({ arrayFields, onAdd, onAddWithInitValue, onMove }: ArrayFieldSnippetProps): SchemaArrayContext => {
32
+ return {
33
+ kind: 'array',
34
+ node,
35
+ render,
36
+ ...arrayState(node, arrayFields.length),
37
+ items: arrayFields.map(({ key, field, onRemove }, index) => ({
38
+ key,
39
+ field,
40
+ index,
41
+ node: describeSchemaField(root, field),
42
+ get value() {
43
+ return get(form.formState.values, field);
44
+ },
45
+ remove: onRemove,
46
+ })),
47
+ add: (index) => {
48
+ const row = blankRow(root, node.field);
49
+ const at = typeof index === 'number' ? index : undefined;
50
+ if (row === undefined) {
51
+ onAdd(at);
52
+ } else {
53
+ onAddWithInitValue(row, at);
54
+ }
55
+ },
56
+ addWithInitValue: onAddWithInitValue,
57
+ move: onMove,
58
+ get error() {
59
+ const own = get(form.formState.errors, node.field);
60
+ return isErrorLeaf(own) ? own : undefined;
61
+ },
62
+ fieldProps: { 'x-field-id': node.field },
63
+ };
64
+ };
53
65
 
54
- untrack(() => warning(node.kind === 'unsupported' && !renderer && !Control, `[Semi Form] SchemaField cannot render "${node.field}": its JSON Schema maps to no control; give it a renderField entry or a widget`));
66
+ $effect(() => {
67
+ warning(node.kind !== 'object' && !renderer, schemaFieldWarnings.noRenderer(node.field, rendererKind));
68
+ });
55
69
  </script>
56
70
 
57
- {#snippet description()}{node.description}{/snippet}
58
-
59
- {#snippet sectionText()}{label.text}{/snippet}
71
+ {#snippet render(field: string)}
72
+ <SchemaNode node={describeSchemaField(root, field)} {renderField} {renderers} {root} />
73
+ {/snippet}
60
74
 
61
- {#snippet properties()}
62
- {#each node.children ?? [] as child (child.field)}
63
- <SchemaNode node={child} {renderField} {root} {widgets} />
75
+ {#snippet content()}
76
+ {#each node.children as child (child.key)}
77
+ <SchemaNode node={child} {renderField} {renderers} {root} />
64
78
  {/each}
65
79
  {/snippet}
66
80
 
67
- {#if renderer}
68
- {@render renderer({ node, field: node.field })}
69
- {:else if Control}
70
- <Control {...controlProps} extraText={node.description ? description : undefined} field={node.field} initValue={node.default} {label} />
71
- {:else if node.kind === 'object'}
72
- {#if node.field === ''}
73
- {@render properties()}
81
+ {#if node.kind === 'object'}
82
+ {#if renderer}
83
+ {@render renderer(objectContext)}
74
84
  {:else}
75
- <FormSection text={sectionText}>{@render properties()}</FormSection>
85
+ {@render content()}
76
86
  {/if}
77
- {:else if node.kind === 'array'}
78
- {#if node.field === ''}
79
- {@render arrayField()}
87
+ {:else if renderer}
88
+ {#if node.kind === 'array'}
89
+ <ArrayField field={node.field}>
90
+ {#snippet children(rows)}
91
+ {@const context = arrayContext(rows)}
92
+ {@render renderer(context)}
93
+ {/snippet}
94
+ </ArrayField>
80
95
  {:else}
81
- <FormSection text={sectionText}>{@render arrayField()}</FormSection>
96
+ {@render renderer(leafContext)}
82
97
  {/if}
83
98
  {/if}
84
-
85
- {#snippet arrayField()}
86
- <ArrayField field={node.field}>
87
- {#snippet children({ arrayFields, onAddWithInitValue, onMove })}
88
- {#each arrayFields as item, index (item.key)}
89
- <div class={rowClass}>
90
- <div class="{rowClass}-content">
91
- <SchemaNode node={describeSchemaField(root, item.field)} {renderField} {root} {widgets} />
92
- </div>
93
- <div class="{rowClass}-actions">
94
- <Button aria-label={itemText('moveUpItem', index)} disabled={index === 0} theme="borderless" type="tertiary" onclick={() => onMove(index, index - 1)}>
95
- {#snippet icon()}<IconArrowUp />{/snippet}
96
- </Button>
97
- <Button aria-label={itemText('moveDownItem', index)} disabled={index === arrayFields.length - 1} theme="borderless" type="tertiary" onclick={() => onMove(index, index + 1)}>
98
- {#snippet icon()}<IconArrowDown />{/snippet}
99
- </Button>
100
- {#if !node.fixed}
101
- <Button aria-label={itemText('removeItem', index)} disabled={node.minItems !== undefined && arrayFields.length <= node.minItems} theme="borderless" type="tertiary" onclick={item.onRemove}>
102
- {#snippet icon()}<IconDelete />{/snippet}
103
- </Button>
104
- {/if}
105
- </div>
106
- </div>
107
- {/each}
108
- {#if !node.fixed}
109
- <Button disabled={node.maxItems !== undefined && arrayFields.length >= node.maxItems} onclick={() => onAddWithInitValue(blankRow(root, node), arrayFields.length)}>
110
- {#snippet icon()}<IconPlus />{/snippet}
111
- {locale().locale.addItem}
112
- </Button>
113
- {/if}
114
- {/snippet}
115
- </ArrayField>
116
- {/snippet}
@@ -1,11 +1,10 @@
1
- import { type Component } from 'svelte';
2
1
  import { type JsonSchema, type SchemaFieldNode } from '@fibrae/semi-foundation/components/form/json-schema';
3
2
  import type { SchemaFieldProps } from '../interface.js';
4
3
  import SchemaNode from './schema-node.svelte';
5
- interface SchemaNodeProps extends Pick<SchemaFieldProps, 'widgets' | 'renderField'> {
4
+ interface SchemaNodeProps extends Pick<SchemaFieldProps, 'renderers' | 'renderField'> {
6
5
  root: JsonSchema;
7
6
  node: SchemaFieldNode;
8
7
  }
9
- declare const SchemaNode: Component<SchemaNodeProps, {}, "">;
8
+ declare const SchemaNode: import("svelte").Component<SchemaNodeProps, {}, "">;
10
9
  type SchemaNode = ReturnType<typeof SchemaNode>;
11
10
  export default SchemaNode;
@@ -0,0 +1,47 @@
1
+ <script lang="ts">
2
+ import { cssClasses } from '@fibrae/semi-foundation/components/form/constants';
3
+ import { singleItemName } from '@fibrae/semi-foundation/components/form/json-schema';
4
+ import { formatLocale } from '@fibrae/semi-foundation/locale';
5
+ import { IconArrowDown, IconArrowUp, IconDelete, IconPlus } from '@fibrae/semi-icons-svelte';
6
+ import Button from '../../button/button.svelte';
7
+ import useLocale from '../../locale/use-locale.svelte.js';
8
+ import type { SchemaArrayContext } from '../interface.js';
9
+ import SemiSection from './semi-section.svelte';
10
+
11
+ let { context }: { context: SchemaArrayContext } = $props();
12
+
13
+ const locale = useLocale('Form');
14
+
15
+ const rowClass = `${cssClasses.PREFIX}-schema-array-row`;
16
+
17
+ const withIndex = (text: string, index: number) => formatLocale(text, { index: index + 1 });
18
+ </script>
19
+
20
+ <SemiSection node={context.node} {...context.fieldProps}>
21
+ {#each context.items as item (item.key)}
22
+ <div class={[rowClass, singleItemName(item.node, locale().locale) !== undefined && `${rowClass}-single`]}>
23
+ <div class="{rowClass}-content">
24
+ {@render context.render(item.field)}
25
+ </div>
26
+ <div class="{rowClass}-actions">
27
+ <Button aria-label={withIndex(locale().locale.moveUpItem, item.index)} disabled={item.index === 0} theme="borderless" type="tertiary" onclick={() => context.move(item.index, item.index - 1)}>
28
+ {#snippet icon()}<IconArrowUp />{/snippet}
29
+ </Button>
30
+ <Button aria-label={withIndex(locale().locale.moveDownItem, item.index)} disabled={item.index === context.count - 1} theme="borderless" type="tertiary" onclick={() => context.move(item.index, item.index + 1)}>
31
+ {#snippet icon()}<IconArrowDown />{/snippet}
32
+ </Button>
33
+ {#if !context.fixed}
34
+ <Button aria-label={withIndex(locale().locale.removeItem, item.index)} disabled={!context.canRemove} theme="borderless" type="tertiary" onclick={item.remove}>
35
+ {#snippet icon()}<IconDelete />{/snippet}
36
+ </Button>
37
+ {/if}
38
+ </div>
39
+ </div>
40
+ {/each}
41
+ {#if !context.fixed}
42
+ <Button disabled={!context.canAdd} onclick={context.add}>
43
+ {#snippet icon()}<IconPlus />{/snippet}
44
+ {locale().locale.addItem}
45
+ </Button>
46
+ {/if}
47
+ </SemiSection>
@@ -0,0 +1,7 @@
1
+ import type { SchemaArrayContext } from '../interface.js';
2
+ type $$ComponentProps = {
3
+ context: SchemaArrayContext;
4
+ };
5
+ declare const SemiArray: import("svelte").Component<$$ComponentProps, {}, "">;
6
+ type SemiArray = ReturnType<typeof SemiArray>;
7
+ export default SemiArray;
@@ -0,0 +1,42 @@
1
+ <script lang="ts">
2
+ import type { Component } from 'svelte';
3
+ import { controlProps, schemaFieldWarnings, singleItemName, type SchemaFieldKind, type SchemaFieldNode } from '@fibrae/semi-foundation/components/form/json-schema';
4
+ import { formatLocale } from '@fibrae/semi-foundation/locale';
5
+ import { warning } from '@fibrae/semi-foundation/utils';
6
+ import useLocale from '../../locale/use-locale.svelte.js';
7
+ import FormInputNumber from '../fields/form-input-number.svelte';
8
+ import FormInput from '../fields/form-input.svelte';
9
+ import FormSelect from '../fields/form-select.svelte';
10
+ import FormSwitch from '../fields/form-switch.svelte';
11
+ import FormTextArea from '../fields/form-text-area.svelte';
12
+
13
+ let { node }: { node: SchemaFieldNode } = $props();
14
+
15
+ const locale = useLocale('Form');
16
+
17
+ const controls: Partial<Record<SchemaFieldKind, Component<any, any, any>>> = { input: FormInput, textarea: FormTextArea, number: FormInputNumber, switch: FormSwitch, select: FormSelect };
18
+ const Control = $derived(controls[node.kind]);
19
+ const itemName = $derived(singleItemName(node, locale().locale));
20
+
21
+ // Svelte's Input names the native attribute `maxlength`
22
+ const controlAttrs = $derived.by(() => {
23
+ const { maxLength, ...rest } = controlProps(node);
24
+ return node.kind === 'input' ? { ...rest, maxlength: maxLength } : rest;
25
+ });
26
+
27
+ const label = $derived({ text: node.title ?? formatLocale(locale().locale.item, { index: (node.item?.index ?? 0) + 1 }), required: node.required });
28
+
29
+ $effect(() => {
30
+ warning(!Control, schemaFieldWarnings.unsupported(node.field));
31
+ });
32
+ </script>
33
+
34
+ {#snippet description()}{node.description}{/snippet}
35
+
36
+ {#if Control}
37
+ {#if itemName === undefined}
38
+ <Control {...controlAttrs} extraText={node.description ? description : undefined} field={node.field} initValue={node.default} {label} />
39
+ {:else}
40
+ <Control {...controlAttrs} aria-label={itemName} field={node.field} initValue={node.default} noLabel />
41
+ {/if}
42
+ {/if}
@@ -0,0 +1,8 @@
1
+ import type { Component } from 'svelte';
2
+ import { type SchemaFieldNode } from '@fibrae/semi-foundation/components/form/json-schema';
3
+ type $$ComponentProps = {
4
+ node: SchemaFieldNode;
5
+ };
6
+ declare const SemiField: Component<$$ComponentProps, {}, "">;
7
+ type SemiField = ReturnType<typeof SemiField>;
8
+ export default SemiField;
@@ -0,0 +1,24 @@
1
+ <script lang="ts" module>
2
+ import type { SchemaArrayContext, SchemaFieldRenderers, SchemaLeafContext, SchemaObjectContext } from '../interface.js';
3
+ import SemiArray from './semi-array.svelte';
4
+ import SemiField from './semi-field.svelte';
5
+ import SemiSection from './semi-section.svelte';
6
+
7
+ /**
8
+ * Renders SchemaField with Semi Form controls: objects and arrays as Sections, array rows with move and remove buttons,
9
+ * single-value rows without a label. Spread it to replace one kind: `{ ...semiRenderers, array: myArray }`.
10
+ */
11
+ export const semiRenderers: Required<SchemaFieldRenderers> = { object, array, field };
12
+ </script>
13
+
14
+ {#snippet object(context: SchemaObjectContext)}
15
+ <SemiSection node={context.node}>{@render context.content()}</SemiSection>
16
+ {/snippet}
17
+
18
+ {#snippet array(context: SchemaArrayContext)}
19
+ <SemiArray {context} />
20
+ {/snippet}
21
+
22
+ {#snippet field(context: SchemaLeafContext)}
23
+ <SemiField node={context.node} />
24
+ {/snippet}