kirbyuse/dist/props.d.mts

Collection of Vue Composition utilities for Kirby CMS

//#region src/props/_block.d.ts
/**
 * @see https://github.com/getkirby/kirby/blob/f9f00b16a22fe9dbbbddc2bfd4719ca3437cbee9/panel/src/components/Forms/Blocks/Elements/BlockTitle.vue#L14
 * @see https://github.com/getkirby/kirby/blob/f9f00b16a22fe9dbbbddc2bfd4719ca3437cbee9/panel/src/components/Forms/Blocks/Types/Default.vue#L15
 */
declare const block: {
  /**
   * The block content is an object of values,
   * depending on the block type.
   */
  content: {
    default: () => {};
    type: (ArrayConstructor | ObjectConstructor)[];
  };
  /**
   * The fieldset definition with all fields, tabs, etc.
   */
  fieldset: {
    default: () => {};
    type: ObjectConstructor;
  };
  /**
   * API endpoints
   * @value { field, model, section }
   */
  endpoints: {
    default: () => {};
    type: (ArrayConstructor | ObjectConstructor)[];
  };
  /**
   * A unique ID for the block
   */
  id: StringConstructor;
};
//#endregion
//#region src/props/after.d.ts
declare const after: {
  /**
   * Optional text that will be shown after the input
   */
  after: StringConstructor;
};
//#endregion
//#region src/props/autocomplete.d.ts
declare const autocomplete: {
  /**
   * Sets the HTML5 autocomplete mode for the input
   */
  autocomplete: StringConstructor;
};
//#endregion
//#region src/props/autofocus.d.ts
declare const autofocus: {
  /**
   * Sets the focus on this field when the form loads. Only the first field with this label gets
   */
  autofocus: BooleanConstructor;
};
//#endregion
//#region src/props/before.d.ts
declare const before: {
  /**
   * Optional text that will be shown before the input
   */
  before: StringConstructor;
};
//#endregion
//#region src/props/disabled.d.ts
declare const disabled: {
  /**
   * If `true`, the field is no longer editable and will not be saved
   */
  disabled: BooleanConstructor;
};
//#endregion
//#region src/props/font.d.ts
declare const font: {
  /**
   * Changes the font of the input to monospace or sans
   */
  font: StringConstructor;
};
//#endregion
//#region src/props/help.d.ts
declare const help: {
  /**
   * Optional help text below the field
   */
  help: StringConstructor;
};
//#endregion
//#region src/props/icon.d.ts
declare const icon: {
  icon: {
    /**
     * Changes the icon to something custom. Use one of the icon names from our icon library or a plugin.
     */
    type: StringConstructor;
  };
};
//#endregion
//#region src/props/id.d.ts
declare const id: {
  /**
   * A unique ID. The component `_uid` will be used as default.
   */
  id: {
    type: (StringConstructor | NumberConstructor)[];
    default(): any;
  };
};
//#endregion
//#region src/props/label.d.ts
declare const label: {
  /**
   * A descriptive label for the field
   */
  label: StringConstructor;
};
//#endregion
//#region src/props/layout.d.ts
declare const layout: {
  /**
   * Display layout
   * @values "list", "cards", "cardlets", "table"
   */
  layout: {
    type: StringConstructor;
    default: string;
  };
};
//#endregion
//#region src/props/maxlength.d.ts
declare const maxlength: {
  /**
   * Maximum number of allowed characters
   */
  maxlength: NumberConstructor;
};
//#endregion
//#region src/props/minlength.d.ts
declare const minlength: {
  /**
   * Minimum number of required characters
   */
  minlength: NumberConstructor;
};
//#endregion
//#region src/props/name.d.ts
declare const name: {
  /**
   * A unique name for the input
   */
  name: (StringConstructor | NumberConstructor)[];
};
//#endregion
//#region src/props/options.d.ts
declare const options: {
  /**
   * An array of option objects
   * @value { value, text, info }
   */
  options: {
    default: () => never[];
    type: ArrayConstructor;
  };
};
//#endregion
//#region src/props/pattern.d.ts
declare const pattern: {
  /**
   * A regular expression, which will be used to validate the input
   */
  pattern: StringConstructor;
};
//#endregion
//#region src/props/placeholder.d.ts
declare const placeholder: {
  /**
   * Custom placeholder text, when the field is empty
   */
  placeholder: (StringConstructor | NumberConstructor)[];
};
//#endregion
//#region src/props/required.d.ts
declare const required: {
  /**
   * If `true`, the field has to be filled in correctly to be submitted
   */
  required: BooleanConstructor;
};
//#endregion
//#region src/props/section.d.ts
declare const section: {
  blueprint: StringConstructor;
  lock: (ObjectConstructor | BooleanConstructor)[];
  help: StringConstructor;
  name: StringConstructor;
  parent: StringConstructor;
  timestamp: NumberConstructor;
};
//#endregion
//#region src/props/spellcheck.d.ts
declare const spellcheck: {
  /**
   * If false, spellchecking will be disabled
   */
  spellcheck: {
    type: BooleanConstructor;
    default: boolean;
  };
};
//#endregion
//#region src/props/type.d.ts
declare const type: {
  type: StringConstructor;
};
//#endregion
export { after, autocomplete, autofocus, before, block, disabled, font, help, icon, id, label, layout, maxlength, minlength, name, options, pattern, placeholder, required, section, spellcheck, type };