Variable: ResourcefulRecord
ts
const ResourcefulRecord: DefineComponent<ExtractPropTypes<AppendDefault<{
actions: {
default: () => never[];
type: PropType<(
| ResourcefulRecordUrlAction
| ResourcefulRecordFunctionAction)[]>;
validator: (v: unknown) => v is (ResourcefulRecordUrlAction | ResourcefulRecordFunctionAction)[];
};
additionalControlBarButtons: {
default: () => never[];
type: PropType<ResourcefulRecordFilterableControlsBarButtonProps[]>;
};
additionalMessages: {
default: () => {
};
type: PropType<Record<string, string>>;
};
advanced: {
default: () => ExtractPublicDefaultPropTypes<{
debug: {
default: boolean;
type: PropType<boolean>;
};
uidForCreate: {
default: string;
type: PropType<string>;
};
}>;
type: PropType<ResourcefulRecordAdvancedOptions>;
};
baseUrl: {
required: true;
type: PropType<string>;
};
bus: {
default: undefined;
type: PropType<
| ResourcefulRecordBusConsumer
| undefined>;
};
callbackToCreate: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudActionCallback
| undefined>;
};
callbackToDelete: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudInstanceActionCallback
| undefined>;
};
callbackToIndex: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudActionCallback
| undefined>;
};
callbackToRead: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudInstanceActionCallback
| undefined>;
};
callbackToUpdate: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudInstanceActionCallback
| undefined>;
};
callOnDirtyStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateDirtyHookHandler[]>;
};
callOnErrorBagStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateErrorBagHookHandler[]>;
};
callOnErrorsStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateErrorsHookHandler[]>;
};
callOnException: {
default: () => never[];
type: PropType<ResourcefulRecordExceptionHookHandler[]>;
};
callOnFailure: {
default: () => never[];
type: PropType<ResourcefulRecordFailureHookHandler[]>;
};
callOnPendingStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStatePendingHookHandler[]>;
};
callOnPrevented: {
default: () => never[];
type: PropType<ResourcefulRecordPreventedHookHandler[]>;
};
callOnProcessing: {
default: () => never[];
type: PropType<ResourcefulRecordProcessingHookHandler[]>;
};
callOnSubmitCountStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateSubmitCountHookHandler[]>;
};
callOnSubmitted: {
default: () => never[];
type: PropType<ResourcefulRecordSubmittedHookHandler[]>;
};
callOnSubmittingStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateSubmittingHookHandler[]>;
};
callOnSuccess: {
default: () => never[];
type: PropType<ResourcefulRecordSuccessHookHandler[]>;
};
callOnTouchedStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateTouchedHookHandler[]>;
};
callOnValidatingStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateValidatingHookHandler[]>;
};
callOnValidStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateValidHookHandler[]>;
};
canCreate: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
canDelete: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
canIndex: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
canRead: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
canUpdate: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
commitButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
commonFieldOptions: {
default: () => ExtractPublicDefaultPropTypes<{
class: PropType<any>;
density: {
default: string;
type: PropType<Density>;
validator: (v: any) => boolean;
};
menuIcon: Omit<{
default: ...;
type: ...;
}, ... | ...> & {
default: ... | ...;
type: PropType<...>;
};
persistentPlaceholder: BooleanConstructor;
style: {
default: null;
type: PropType<StyleValue>;
};
theme: StringConstructor;
variant: {
default: string;
type: PropType<... | ... | ... | ... | ... | ... | ...>;
validator: (v: any) => boolean;
};
}>;
type: PropType<ResourcefulRecordCommonFieldProps>;
};
container: {
default: () => {
width: string;
};
type: PropType<ResourcefulRecordVCardProps>;
};
controlButtonBarOptions: {
default: () => {
gap: number;
};
type: PropType<ControlButtonBarOptionsProps>;
};
controlButtonOptions: {
default: () => {
color: string;
};
type: PropType<ControlButtonProps>;
};
createButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
deleteButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
fieldLabels: {
default: () => {
};
type: PropType<Record<string, string>>;
};
fireAlertFn: {
default: undefined;
type: PropType<
| FireAlertFn
| undefined>;
};
indexButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
initialValues: {
default: undefined;
type: PropType<
| Record<string, any>
| null
| undefined>;
};
metaProgressColor: {
default: string;
type: PropType<string>;
};
mode: {
default: string;
type: PropType<"update" | "read" | "create">;
validator: (v: string) => boolean;
};
onError?: PropType<(...args: [unknown]) => void | undefined>;
onException?: PropType<(...args: [unknown]) => void | undefined>;
onFailure?: PropType<
| (...args: [ResourcefulHttpResponse<unknown>, Record<string, any>]) => void
| undefined>;
onPrevented?: PropType<
| (...args: [Record<string, any>, ValidationError]) => void
| undefined>;
onProcessing?: PropType<
| (...args: [ResourcefulHttpProgress, Record<string, any>]) => void
| undefined>;
onState?: PropType<(...args: [string | null]) => void | undefined>;
onState:dirty?: PropType<(...args: [boolean]) => void | undefined>;
onState:errorBag?: PropType<
| (...args: [Partial<Record<..., ...>>]) => void
| undefined>;
onState:errors?: PropType<
| (...args: [Record<string, ... | ...>]) => void
| undefined>;
onState:pending?: PropType<(...args: [boolean]) => void | undefined>;
onState:submitCount?: PropType<(...args: [number]) => void | undefined>;
onState:submitting?: PropType<(...args: [boolean]) => void | undefined>;
onState:touched?: PropType<(...args: [boolean]) => void | undefined>;
onState:valid?: PropType<(...args: [boolean]) => void | undefined>;
onState:validating?: PropType<(...args: [boolean]) => void | undefined>;
onSubmitted?: PropType<
| (...args: [Record<string, any>]) => void
| undefined>;
onSuccess?: PropType<
| (...args: [ResourceResourcefulRecordResponse, Record<string, any>]) => void
| undefined>;
onUpdate:state?: PropType<(...args: [string | null]) => void | undefined>;
overrideMessages: {
default: () => {
};
type: PropType<Partial<Record<
| "alternatives.all"
| "alternatives.any"
| "alternatives.match"
| "alternatives.one"
| "alternatives.types"
| "any.custom"
| "any.default"
| "any.failover"
| "any.invalid"
| "any.only"
| "any.ref"
| "any.required"
| "any.unknown"
| "array.base"
| "array.excludes"
| "array.hasKnown"
| "array.hasUnknown"
| "array.includes"
| "array.includesRequiredBoth"
| "array.includesRequiredKnowns"
| "array.includesRequiredUnknowns"
| "array.length"
| "array.max"
| "array.min"
| "array.orderedLength"
| "array.sort"
| "array.sort.mismatching"
| "array.sort.unsupported"
| "array.sparse"
| "array.unique"
| "boolean.base"
| "date.base"
| "date.format"
| "date.greater"
| "date.less"
| "date.max"
| "date.min"
| "date.format.iso"
| "date.format.javascript"
| "date.format.unix"
| "function.arity"
| "function.class"
| "function.maxArity"
| "function.minArity"
| "number.base"
| "number.greater"
| "number.infinity"
| "number.integer"
| "number.less"
| "number.max"
| "number.min"
| "number.multiple"
| "number.negative"
| "number.port"
| "number.positive"
| "number.precision"
| "number.unsafe"
| "object.and"
| "object.assert"
| "object.base"
| "object.instance"
| "object.length"
| "object.max"
| "object.min"
| "object.missing"
| "object.nand"
| "object.oxor"
| "object.pattern.match"
| "object.refType"
| "object.regex"
| "object.rename.multiple"
| "object.rename.override"
| "object.schema"
| "object.unknown"
| "object.with"
| "object.without"
| "object.xor"
| "string.alphanum"
| "string.base"
| "string.base64"
| "string.creditCard"
| "string.dataUri"
| "string.domain"
| "string.email"
| "string.empty"
| "string.guid"
| "string.hex"
| "string.hexAlign"
| "string.hostname"
| "string.ip"
| "string.ipVersion"
| "string.isoDate"
| "string.isoDuration"
| "string.length"
| "string.lowercase"
| "string.max"
| "string.min"
| "string.normalize"
| "string.token"
| "string.pattern.base"
| "string.pattern.name"
| "string.pattern.invert.base"
| "string.pattern.invert.name"
| "string.trim"
| "string.uri"
| "string.uriCustomScheme"
| "string.uriRelativeOnly"
| "string.uppercase"
| "symbol.base"
| "symbol.map"
| "binary.base"
| "binary.length"
| "binary.max"
| "binary.min"
| "bigint.base"
| "bigint.greater"
| "bigint.less"
| "bigint.max"
| "bigint.min"
| "bigint.multiple"
| "bigint.negative"
| "bigint.positive"
| "datetime.base"
| "datetime.exactly"
| "datetime.equals"
| "datetime.after"
| "datetime.greater"
| "datetime.before"
| "datetime.less"
| "datetime.afterOrEqual"
| "datetime.min"
| "datetime.beforeOrEqual"
| "datetime.max"
| "datetime.weekend"
| "datetime.weekday"
| "phone.base"
| "phone.invalid"
| "phone.fixedLine"
| "phone.mobile"
| "phone.strictFixedLine"
| "phone.strictMobile"
| "phone.fixedLineOrMobile"
| "phone.tollFree"
| "phone.premiumRate"
| "phone.sharedCost"
| "phone.voip"
| "phone.personalNumber"
| "phone.pager"
| "phone.uan"
| "phone.voicemail"
| "phone.unknown"
| "phone.types", string>>>;
};
readButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
refreshButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
resetButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
routeToCreate: {
default: undefined;
type: PropType<
| ResourcefulRecordNavOptions
| undefined>;
validator: (v: unknown) => v is RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
};
routeToDelete: {
default: undefined;
type: PropType<
| ResourcefulRecordRouteOptions
| undefined>;
validator: (v: unknown) => v is ResourcefulRecordRouteOptions | undefined;
};
routeToIndex: {
default: undefined;
type: PropType<
| ResourcefulRecordNavOptions
| undefined>;
validator: (v: unknown) => v is RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
};
routeToRead: {
default: undefined;
type: PropType<
| ResourcefulRecordRouteOptions
| undefined>;
validator: (v: unknown) => v is ResourcefulRecordRouteOptions | undefined;
};
routeToUpdate: {
default: undefined;
type: PropType<
| ResourcefulRecordRouteOptions
| undefined>;
validator: (v: unknown) => v is ResourcefulRecordRouteOptions | undefined;
};
specificFieldOptions: {
default: () => {
};
type: PropType<ResourcefulRecordFieldSpecificProps>;
};
state: {
default: undefined;
type: PropType<string | null | undefined>;
};
uid: {
default: undefined;
type: PropType<string | null | undefined>;
};
updateButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
}, {
}>>, {
doFormSubmit: (...args: [Event]) => void;
doResetForm: (...args: [Partial<FormState<any>>, Partial<ResetFormOpts>]) => void;
forceUpdateInitialValues: (...args: []) => void;
forceUpdateSchema: (...args: []) => void;
formValues: ComputedRef<any>;
record: | ShallowRef<Record<string, any>, Record<string, any>>
| ShallowRef<ResourceResourcefulRecordResponse, ResourceResourcefulRecordResponse>;
refresh: () => Promise<void>;
setFieldTouched: (...args: [string, boolean]) => void;
setFieldValue: (...args: [string, any]) => void;
setTouched: (...args: [
| boolean
| Partial<Record<string, boolean>>]) => void;
setValues: (...args: [any, boolean]) => void;
validate: (...args: [Partial<ValidationOptions$1>]) => void;
validateField: (...args: [string, Partial<ValidationOptions$1>]) => void;
}, {
}, {
}, {
}, ComponentOptionsMixin, ComponentOptionsMixin, EmitFunctions<{
error: (error: unknown) => true;
exception: (exception: unknown) => true;
failure: (response: ResourcefulHttpResponse, values: Record<string, any>) => boolean;
prevented: (values: Record<string, any>, error: ValidationError) => boolean;
processing: (progress: ResourcefulHttpProgress, values: Record<string, any>) => boolean;
state: (state: string | null | undefined) => boolean;
state:dirty: (is: boolean) => boolean;
state:errorBag: (errors: Partial<Record<string, string[]>>) => boolean;
state:errors: (errors: Record<string, string | undefined>) => boolean;
state:pending: (is: boolean) => boolean;
state:submitCount: (count: number) => boolean;
state:submitting: (is: boolean) => boolean;
state:touched: (is: boolean) => boolean;
state:valid: (is: boolean) => boolean;
state:validating: (is: boolean) => boolean;
submitted: (values: Record<string, any>) => boolean;
success: (response: ResourceResourcefulRecordResponse, values: Record<string, any>) => boolean;
update:state: (state: string | null | undefined) => boolean;
}>, string, PublicProps, ToResolvedProps<ExtractPropTypes<AppendDefault<{
actions: {
default: () => never[];
type: PropType<(
| ResourcefulRecordUrlAction
| ResourcefulRecordFunctionAction)[]>;
validator: (v: unknown) => v is (ResourcefulRecordUrlAction | ResourcefulRecordFunctionAction)[];
};
additionalControlBarButtons: {
default: () => never[];
type: PropType<ResourcefulRecordFilterableControlsBarButtonProps[]>;
};
additionalMessages: {
default: () => {
};
type: PropType<Record<string, string>>;
};
advanced: {
default: () => ExtractPublicDefaultPropTypes<{
debug: {
default: boolean;
type: PropType<...>;
};
uidForCreate: {
default: string;
type: PropType<...>;
};
}>;
type: PropType<ResourcefulRecordAdvancedOptions>;
};
baseUrl: {
required: true;
type: PropType<string>;
};
bus: {
default: undefined;
type: PropType<
| ResourcefulRecordBusConsumer
| undefined>;
};
callbackToCreate: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudActionCallback
| undefined>;
};
callbackToDelete: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudInstanceActionCallback
| undefined>;
};
callbackToIndex: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudActionCallback
| undefined>;
};
callbackToRead: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudInstanceActionCallback
| undefined>;
};
callbackToUpdate: {
default: undefined;
type: PropType<
| ResourcefulRecordCrudInstanceActionCallback
| undefined>;
};
callOnDirtyStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateDirtyHookHandler[]>;
};
callOnErrorBagStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateErrorBagHookHandler[]>;
};
callOnErrorsStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateErrorsHookHandler[]>;
};
callOnException: {
default: () => never[];
type: PropType<ResourcefulRecordExceptionHookHandler[]>;
};
callOnFailure: {
default: () => never[];
type: PropType<ResourcefulRecordFailureHookHandler[]>;
};
callOnPendingStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStatePendingHookHandler[]>;
};
callOnPrevented: {
default: () => never[];
type: PropType<ResourcefulRecordPreventedHookHandler[]>;
};
callOnProcessing: {
default: () => never[];
type: PropType<ResourcefulRecordProcessingHookHandler[]>;
};
callOnSubmitCountStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateSubmitCountHookHandler[]>;
};
callOnSubmitted: {
default: () => never[];
type: PropType<ResourcefulRecordSubmittedHookHandler[]>;
};
callOnSubmittingStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateSubmittingHookHandler[]>;
};
callOnSuccess: {
default: () => never[];
type: PropType<ResourcefulRecordSuccessHookHandler[]>;
};
callOnTouchedStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateTouchedHookHandler[]>;
};
callOnValidatingStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateValidatingHookHandler[]>;
};
callOnValidStateChange: {
default: () => never[];
type: PropType<ResourcefulRecordChangeStateValidHookHandler[]>;
};
canCreate: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
canDelete: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
canIndex: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
canRead: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
canUpdate: {
default: boolean;
type: PropType<
| boolean
| ResourcefulRecordActionIsActionableValidator>;
};
commitButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
commonFieldOptions: {
default: () => ExtractPublicDefaultPropTypes<{
class: PropType<any>;
density: {
default: string;
type: PropType<...>;
validator: (v: ...) => ...;
};
menuIcon: Omit<..., ...> & {
default: ...;
type: ...;
};
persistentPlaceholder: BooleanConstructor;
style: {
default: null;
type: PropType<...>;
};
theme: StringConstructor;
variant: {
default: string;
type: PropType<...>;
validator: (v: ...) => ...;
};
}>;
type: PropType<ResourcefulRecordCommonFieldProps>;
};
container: {
default: () => {
width: string;
};
type: PropType<ResourcefulRecordVCardProps>;
};
controlButtonBarOptions: {
default: () => {
gap: number;
};
type: PropType<ControlButtonBarOptionsProps>;
};
controlButtonOptions: {
default: () => {
color: string;
};
type: PropType<ControlButtonProps>;
};
createButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
deleteButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
fieldLabels: {
default: () => {
};
type: PropType<Record<string, string>>;
};
fireAlertFn: {
default: undefined;
type: PropType<
| FireAlertFn
| undefined>;
};
indexButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
initialValues: {
default: undefined;
type: PropType<
| Record<string, any>
| null
| undefined>;
};
metaProgressColor: {
default: string;
type: PropType<string>;
};
mode: {
default: string;
type: PropType<"update" | "read" | "create">;
validator: (v: string) => boolean;
};
onError?: PropType<(...args: [unknown]) => void | undefined>;
onException?: PropType<(...args: [unknown]) => void | undefined>;
onFailure?: PropType<
| (...args: [ResourcefulHttpResponse<...>, Record<..., ...>]) => void
| undefined>;
onPrevented?: PropType<
| (...args: [Record<..., ...>, ValidationError]) => void
| undefined>;
onProcessing?: PropType<
| (...args: [ResourcefulHttpProgress, Record<..., ...>]) => void
| undefined>;
onState?: PropType<(...args: [... | ... | ...]) => void | undefined>;
onState:dirty?: PropType<(...args: [boolean]) => void | undefined>;
onState:errorBag?: PropType<
| (...args: [Partial<...>]) => void
| undefined>;
onState:errors?: PropType<
| (...args: [Record<..., ...>]) => void
| undefined>;
onState:pending?: PropType<(...args: [boolean]) => void | undefined>;
onState:submitCount?: PropType<(...args: [number]) => void | undefined>;
onState:submitting?: PropType<(...args: [boolean]) => void | undefined>;
onState:touched?: PropType<(...args: [boolean]) => void | undefined>;
onState:valid?: PropType<(...args: [boolean]) => void | undefined>;
onState:validating?: PropType<(...args: [boolean]) => void | undefined>;
onSubmitted?: PropType<
| (...args: [Record<..., ...>]) => void
| undefined>;
onSuccess?: PropType<
| (...args: [ResourceResourcefulRecordResponse, Record<..., ...>]) => void
| undefined>;
onUpdate:state?: PropType<(...args: [... | ... | ...]) => void | undefined>;
overrideMessages: {
default: () => {
};
type: PropType<Partial<Record<
| "alternatives.all"
| "alternatives.any"
| "alternatives.match"
| "alternatives.one"
| "alternatives.types"
| "any.custom"
| "any.default"
| "any.failover"
| "any.invalid"
| "any.only"
| "any.ref"
| "any.required"
| "any.unknown"
| "array.base"
| "array.excludes"
| "array.hasKnown"
| "array.hasUnknown"
| "array.includes"
| "array.includesRequiredBoth"
| "array.includesRequiredKnowns"
| "array.includesRequiredUnknowns"
| "array.length"
| "array.max"
| "array.min"
| "array.orderedLength"
| "array.sort"
| "array.sort.mismatching"
| "array.sort.unsupported"
| "array.sparse"
| "array.unique"
| "boolean.base"
| "date.base"
| "date.format"
| "date.greater"
| "date.less"
| "date.max"
| "date.min"
| "date.format.iso"
| "date.format.javascript"
| "date.format.unix"
| "function.arity"
| "function.class"
| "function.maxArity"
| "function.minArity"
| "number.base"
| "number.greater"
| "number.infinity"
| "number.integer"
| "number.less"
| "number.max"
| "number.min"
| "number.multiple"
| "number.negative"
| "number.port"
| "number.positive"
| "number.precision"
| "number.unsafe"
| "object.and"
| "object.assert"
| "object.base"
| "object.instance"
| "object.length"
| "object.max"
| "object.min"
| "object.missing"
| "object.nand"
| "object.oxor"
| "object.pattern.match"
| "object.refType"
| "object.regex"
| "object.rename.multiple"
| "object.rename.override"
| "object.schema"
| "object.unknown"
| "object.with"
| "object.without"
| "object.xor"
| "string.alphanum"
| "string.base"
| "string.base64"
| "string.creditCard"
| "string.dataUri"
| "string.domain"
| "string.email"
| "string.empty"
| "string.guid"
| "string.hex"
| "string.hexAlign"
| "string.hostname"
| "string.ip"
| "string.ipVersion"
| "string.isoDate"
| "string.isoDuration"
| "string.length"
| "string.lowercase"
| "string.max"
| "string.min"
| "string.normalize"
| "string.token"
| "string.pattern.base"
| "string.pattern.name"
| "string.pattern.invert.base"
| "string.pattern.invert.name"
| "string.trim"
| "string.uri"
| "string.uriCustomScheme"
| "string.uriRelativeOnly"
| "string.uppercase"
| "symbol.base"
| "symbol.map"
| "binary.base"
| "binary.length"
| "binary.max"
| "binary.min"
| "bigint.base"
| "bigint.greater"
| "bigint.less"
| "bigint.max"
| "bigint.min"
| "bigint.multiple"
| "bigint.negative"
| "bigint.positive"
| "datetime.base"
| "datetime.exactly"
| "datetime.equals"
| "datetime.after"
| "datetime.greater"
| "datetime.before"
| "datetime.less"
| "datetime.afterOrEqual"
| "datetime.min"
| "datetime.beforeOrEqual"
| "datetime.max"
| "datetime.weekend"
| "datetime.weekday"
| "phone.base"
| "phone.invalid"
| "phone.fixedLine"
| "phone.mobile"
| "phone.strictFixedLine"
| "phone.strictMobile"
| "phone.fixedLineOrMobile"
| "phone.tollFree"
| "phone.premiumRate"
| "phone.sharedCost"
| "phone.voip"
| "phone.personalNumber"
| "phone.pager"
| "phone.uan"
| "phone.voicemail"
| "phone.unknown"
| "phone.types", string>>>;
};
readButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
refreshButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
resetButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
routeToCreate: {
default: undefined;
type: PropType<
| ResourcefulRecordNavOptions
| undefined>;
validator: (v: unknown) => v is RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
};
routeToDelete: {
default: undefined;
type: PropType<
| ResourcefulRecordRouteOptions
| undefined>;
validator: (v: unknown) => v is ResourcefulRecordRouteOptions | undefined;
};
routeToIndex: {
default: undefined;
type: PropType<
| ResourcefulRecordNavOptions
| undefined>;
validator: (v: unknown) => v is RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
};
routeToRead: {
default: undefined;
type: PropType<
| ResourcefulRecordRouteOptions
| undefined>;
validator: (v: unknown) => v is ResourcefulRecordRouteOptions | undefined;
};
routeToUpdate: {
default: undefined;
type: PropType<
| ResourcefulRecordRouteOptions
| undefined>;
validator: (v: unknown) => v is ResourcefulRecordRouteOptions | undefined;
};
specificFieldOptions: {
default: () => {
};
type: PropType<ResourcefulRecordFieldSpecificProps>;
};
state: {
default: undefined;
type: PropType<string | null | undefined>;
};
uid: {
default: undefined;
type: PropType<string | null | undefined>;
};
updateButtonOverrides: {
default: () => {
};
type: PropType<Partial<ControlButtonOverrideProps>>;
};
}, {
}>>, EmitFunctions<{
error: (error: unknown) => true;
exception: (exception: unknown) => true;
failure: (response: ResourcefulHttpResponse, values: Record<string, any>) => boolean;
prevented: (values: Record<string, any>, error: ValidationError) => boolean;
processing: (progress: ResourcefulHttpProgress, values: Record<string, any>) => boolean;
state: (state: string | null | undefined) => boolean;
state:dirty: (is: boolean) => boolean;
state:errorBag: (errors: Partial<Record<string, string[]>>) => boolean;
state:errors: (errors: Record<string, string | undefined>) => boolean;
state:pending: (is: boolean) => boolean;
state:submitCount: (count: number) => boolean;
state:submitting: (is: boolean) => boolean;
state:touched: (is: boolean) => boolean;
state:valid: (is: boolean) => boolean;
state:validating: (is: boolean) => boolean;
submitted: (values: Record<string, any>) => boolean;
success: (response: ResourceResourcefulRecordResponse, values: Record<string, any>) => boolean;
update:state: (state: string | null | undefined) => boolean;
}>>, {
actions: (
| ResourcefulRecordUrlAction
| ResourcefulRecordFunctionAction)[];
additionalControlBarButtons: ResourcefulRecordFilterableControlsBarButtonProps[];
additionalMessages: Record<string, string>;
advanced: {
debug?: boolean;
uidForCreate?: string;
};
bus: | ResourcefulRecordBusConsumer
| undefined;
callbackToCreate: | ResourcefulRecordCrudActionCallback
| undefined;
callbackToDelete: | ResourcefulRecordCrudInstanceActionCallback
| undefined;
callbackToIndex: | ResourcefulRecordCrudActionCallback
| undefined;
callbackToRead: | ResourcefulRecordCrudInstanceActionCallback
| undefined;
callbackToUpdate: | ResourcefulRecordCrudInstanceActionCallback
| undefined;
callOnDirtyStateChange: ResourcefulRecordChangeStateDirtyHookHandler[];
callOnErrorBagStateChange: ResourcefulRecordChangeStateErrorBagHookHandler[];
callOnErrorsStateChange: ResourcefulRecordChangeStateErrorsHookHandler[];
callOnException: ResourcefulRecordExceptionHookHandler[];
callOnFailure: ResourcefulRecordFailureHookHandler[];
callOnPendingStateChange: ResourcefulRecordChangeStatePendingHookHandler[];
callOnPrevented: ResourcefulRecordPreventedHookHandler[];
callOnProcessing: ResourcefulRecordProcessingHookHandler[];
callOnSubmitCountStateChange: ResourcefulRecordChangeStateSubmitCountHookHandler[];
callOnSubmitted: ResourcefulRecordSubmittedHookHandler[];
callOnSubmittingStateChange: ResourcefulRecordChangeStateSubmittingHookHandler[];
callOnSuccess: ResourcefulRecordSuccessHookHandler[];
callOnTouchedStateChange: ResourcefulRecordChangeStateTouchedHookHandler[];
callOnValidatingStateChange: ResourcefulRecordChangeStateValidatingHookHandler[];
callOnValidStateChange: ResourcefulRecordChangeStateValidHookHandler[];
canCreate: | boolean
| ResourcefulRecordActionIsActionableValidator;
canDelete: | boolean
| ResourcefulRecordActionIsActionableValidator;
canIndex: | boolean
| ResourcefulRecordActionIsActionableValidator;
canRead: | boolean
| ResourcefulRecordActionIsActionableValidator;
canUpdate: | boolean
| ResourcefulRecordActionIsActionableValidator;
commitButtonOverrides: Partial<ControlButtonOverrideProps>;
commonFieldOptions: {
class?: any;
density?: Density;
menuIcon?: | IconValue
| () => VNode<RendererNode, RendererElement, {
[key: string]: any;
}>;
persistentPlaceholder?: boolean;
style?: StyleValue;
theme?: string;
variant?: | "outlined"
| "plain"
| "underlined"
| "filled"
| "solo"
| "solo-inverted"
| "solo-filled";
};
container: ResourcefulRecordVCardProps;
controlButtonBarOptions: {
class?: any;
gap?: string | number;
justification?: "start" | "end";
overflowMenuButtonOptions?: {
color?: string;
cta?: string;
density?: Density;
size?: "small" | "x-small" | "medium" | "large" | "x-large";
};
style?: StyleValue;
};
controlButtonOptions: ControlButtonProps;
createButtonOverrides: Partial<ControlButtonOverrideProps>;
deleteButtonOverrides: Partial<ControlButtonOverrideProps>;
fieldLabels: Record<string, string>;
fireAlertFn: | FireAlertFn
| undefined;
indexButtonOverrides: Partial<ControlButtonOverrideProps>;
initialValues: | Record<string, any>
| null
| undefined;
metaProgressColor: string;
mode: "update" | "read" | "create";
overrideMessages: Partial<Record<
| "alternatives.all"
| "alternatives.any"
| "alternatives.match"
| "alternatives.one"
| "alternatives.types"
| "any.custom"
| "any.default"
| "any.failover"
| "any.invalid"
| "any.only"
| "any.ref"
| "any.required"
| "any.unknown"
| "array.base"
| "array.excludes"
| "array.hasKnown"
| "array.hasUnknown"
| "array.includes"
| "array.includesRequiredBoth"
| "array.includesRequiredKnowns"
| "array.includesRequiredUnknowns"
| "array.length"
| "array.max"
| "array.min"
| "array.orderedLength"
| "array.sort"
| "array.sort.mismatching"
| "array.sort.unsupported"
| "array.sparse"
| "array.unique"
| "boolean.base"
| "date.base"
| "date.format"
| "date.greater"
| "date.less"
| "date.max"
| "date.min"
| "date.format.iso"
| "date.format.javascript"
| "date.format.unix"
| "function.arity"
| "function.class"
| "function.maxArity"
| "function.minArity"
| "number.base"
| "number.greater"
| "number.infinity"
| "number.integer"
| "number.less"
| "number.max"
| "number.min"
| "number.multiple"
| "number.negative"
| "number.port"
| "number.positive"
| "number.precision"
| "number.unsafe"
| "object.and"
| "object.assert"
| "object.base"
| "object.instance"
| "object.length"
| "object.max"
| "object.min"
| "object.missing"
| "object.nand"
| "object.oxor"
| "object.pattern.match"
| "object.refType"
| "object.regex"
| "object.rename.multiple"
| "object.rename.override"
| "object.schema"
| "object.unknown"
| "object.with"
| "object.without"
| "object.xor"
| "string.alphanum"
| "string.base"
| "string.base64"
| "string.creditCard"
| "string.dataUri"
| "string.domain"
| "string.email"
| "string.empty"
| "string.guid"
| "string.hex"
| "string.hexAlign"
| "string.hostname"
| "string.ip"
| "string.ipVersion"
| "string.isoDate"
| "string.isoDuration"
| "string.length"
| "string.lowercase"
| "string.max"
| "string.min"
| "string.normalize"
| "string.token"
| "string.pattern.base"
| "string.pattern.name"
| "string.pattern.invert.base"
| "string.pattern.invert.name"
| "string.trim"
| "string.uri"
| "string.uriCustomScheme"
| "string.uriRelativeOnly"
| "string.uppercase"
| "symbol.base"
| "symbol.map"
| "binary.base"
| "binary.length"
| "binary.max"
| "binary.min"
| "bigint.base"
| "bigint.greater"
| "bigint.less"
| "bigint.max"
| "bigint.min"
| "bigint.multiple"
| "bigint.negative"
| "bigint.positive"
| "datetime.base"
| "datetime.exactly"
| "datetime.equals"
| "datetime.after"
| "datetime.greater"
| "datetime.before"
| "datetime.less"
| "datetime.afterOrEqual"
| "datetime.min"
| "datetime.beforeOrEqual"
| "datetime.max"
| "datetime.weekend"
| "datetime.weekday"
| "phone.base"
| "phone.invalid"
| "phone.fixedLine"
| "phone.mobile"
| "phone.strictFixedLine"
| "phone.strictMobile"
| "phone.fixedLineOrMobile"
| "phone.tollFree"
| "phone.premiumRate"
| "phone.sharedCost"
| "phone.voip"
| "phone.personalNumber"
| "phone.pager"
| "phone.uan"
| "phone.voicemail"
| "phone.unknown"
| "phone.types", string>>;
readButtonOverrides: Partial<ControlButtonOverrideProps>;
refreshButtonOverrides: Partial<ControlButtonOverrideProps>;
resetButtonOverrides: Partial<ControlButtonOverrideProps>;
routeToCreate: | {
force?: boolean;
hash?: string;
name?: RouteRecordNameGeneric;
params?: RouteParamsRawGeneric;
path?: string;
query?: LocationQueryRaw;
replace?: boolean;
}
| undefined;
routeToDelete: | ResourcefulRecordRouteOptions
| undefined;
routeToIndex: | {
force?: boolean;
hash?: string;
name?: RouteRecordNameGeneric;
params?: RouteParamsRawGeneric;
path?: string;
query?: LocationQueryRaw;
replace?: boolean;
}
| undefined;
routeToRead: | ResourcefulRecordRouteOptions
| undefined;
routeToUpdate: | ResourcefulRecordRouteOptions
| undefined;
specificFieldOptions: ResourcefulRecordFieldSpecificProps;
state: string | null | undefined;
uid: string | null | undefined;
updateButtonOverrides: Partial<ControlButtonOverrideProps>;
}, ResourcefulRecordComponentSlots, {
}, {
}, string, ComponentProvideOptions, true, {
}, any>;