gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: key value widget (#865)

Browse Source
This commit is contained in:
Daniel Lautzenheiser
2023-09-06 16:30:51 -04:00
committed by GitHub
parent 6bcf451a18
commit dbf007a586
24 changed files with 1059 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
packages/core/src/interface.ts
View File

@ -164,6 +164,15 @@ export type FieldValidationMethod<T = unknown, F extends BaseField = UnknownFiel
props: FieldValidationMethodProps<T, F>,
) => false | FieldError | Promise<false | FieldError>;
export interface FieldStorageConverters<
T = unknown,
F extends BaseField = UnknownField,
S = ValueOrNestedValue,
> {
deserialize(storageValue: S | null | undefined, field: F): T | null | undefined;
serialize(cmsValue: T | null | undefined, field: F): S | null | undefined;
}
export interface EntryDraft {
entry: Entry;
fieldsErrors: FieldsErrors;
@ -400,17 +409,23 @@ export type FieldPreviewComponent<T = unknown, F extends BaseField = UnknownFiel
FieldPreviewProps<T, F>
>;
export interface WidgetOptions<T = unknown, F extends BaseField = UnknownField> {
export interface WidgetOptions<
T = unknown,
F extends BaseField = UnknownField,
S = ValueOrNestedValue,
> {
validator?: Widget<T, F>['validator'];
getValidValue?: Widget<T, F>['getValidValue'];
converters?: Widget<T, F, S>['converters'];
getDefaultValue?: Widget<T, F>['getDefaultValue'];
schema?: Widget<T, F>['schema'];
}
export interface Widget<T = unknown, F extends BaseField = UnknownField> {
export interface Widget<T = unknown, F extends BaseField = UnknownField, S = ValueOrNestedValue> {
control: ComponentType<WidgetControlProps<T, F>>;
preview?: WidgetPreviewComponent<T, F>;
validator: FieldValidationMethod<T, F>;
converters: FieldStorageConverters<T, F, S>;
getValidValue: FieldGetValidValueMethod<T, F>;
getDefaultValue?: FieldGetDefaultMethod<T, F>;
schema?: PropertiesSchema<unknown>;
@ -669,6 +684,18 @@ export interface ObjectField<EF extends BaseField = UnknownField> extends BaseFi
fields: Field<EF>[];
}
export interface KeyValueField extends BaseField {
widget: 'keyvalue';
default?: Record<string, string>;
label_singular?: string;
key_label?: string;
value_label?: string;
min?: number;
max?: number;
}
export interface ListField<EF extends BaseField = UnknownField> extends BaseField {
widget: 'list';
default?: ValueOrNestedValue[];