Fast CRUD Documentation

website·Indexed 32 days ago

http://fast-crud.docmirror.cn/

A framework for rapidly building CRUD interfaces, featuring components like FsToolbar and FsActionbar. The documentation includes comprehensive TypeScript type definitions for CrudOptions, CrudBinding, and various form and table property aliases such as ColumnProps and FormItemProps.

Tokens
91.1K
Snippets
391
Records
920
Agent score
54%

What's inside Fast CRUD

  1. Overview of fast-crud extension packages

    Extension packages in fast-crud allow developers to bundle groups of cell display components, form input components, and field types into a single package. These packages can be published to npm for reuse. Once an extension package is installed, components are activated by configuring the corresponding field type in the field definition.
  2. Overview of FastCrud features

    FastCrud is a configuration-oriented framework for rapid CRUD development. Key features include:

    • Support for multiple UI libraries: Ant Design Vue (antdv), Element Plus, and Naive UI.
    • Rich set of field types to reduce boilerplate code.
    • Support for custom requirements and RBAC (Role-Based Access Control) permission management.
    • Lazy loading for extended components to ensure initial page load performance is not impacted by large component sizes.
  3. Overview of FastCrud (fs)

    FastCrud (fs) is a configuration-oriented CRUD development framework built on Vue 3. It is designed to accelerate the development of CRUD (Create, Read, Update, Delete) functionality and can be used as a base framework for low-code platforms. It supports multiple UI libraries including Ant Design Vue, Element Plus, and Naive UI.
  4. Use FsForm for configuration-driven forms

    FsForm is a configuration-driven form component. It provides a programmatic interface via a ref to manage form submission and state reset.
    // Exposed methods via ref
    ref.value.submit(); // Submit the form
    ref.value.reset();  // Reset the form
  5. Use FsValuesFormat to format and display values

    The FsValuesFormat component is used to format the display of values, supporting dictionary mapping, multi-value splitting, and customizable rendering (such as tags or plain text). It can automatically assign colors based on the value's hashcode when color is set to auto.
  6. Use ValueBuilderProps for value building parameters

    The ValueBuilderProps type alias in @fast-crud/fast-crud defines the structure of the parameters passed during the value building process. It provides context about the current column, form, row, and the specific value being processed.
    type ValueBuilderProps = {
      column?: any;   // The column configuration
      form?: any;     // The form instance/context
      index: number;   // The index of the item
      key: string;     // The unique key of the field
      mode?: string;   // The current operation mode
      row?: any;       // The current row data
      value: any;      // The value to be built/processed
    };