yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-12-12 15:32:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Link to documentation instead

Browse Source
This commit is contained in:
oiorain 2022-11-08 14:11:40 +01:00
parent 2f9d750c95
commit 93535bc2c8
1 changed files with 2 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
docs/docs/custom-fields.md
View File

@ -40,62 +40,9 @@ The custom field will be added to Strapi during the server [register lifecycle](
### Admin
Here's how you register a Custom Field on the admin:
To register a custom field on the server, see [documentation](https://docs.strapi.io/developer-docs/latest/development/custom-fields.html#registering-a-custom-field-on-the-server).
```tsx
// You can also pass an array of objects to register several custom fields at once
app.customFields.register(
options: CustomFieldAdminOptions | CustomFieldAdminOptions[]
);
interface CustomFieldAdminOptions {
// The name of the custom field
name: string;
// The name of the plugin creating the custom field
pluginId?: string;
// The existing Strapi data type the custom field will use
type: string;
// The translation for the name
intlLabel: IntlObject;
// The translation for the description
intlDescription: IntlObject;
// The icon for the custom field
icon?: React.ComponentType;
// The components needed to display the custom field in the Content Manager
components: {
// Input component for the Edit view
Input: () => Promise<{ default: React.ReactComponent }>;
// Read only component for the List view
View: () => Promise<{ default: React.ReactComponent }>;
};
// The settings to extend in the Content-Type Builder
options?: {
base: CTBFormSection[];
advanced: CTBFormSection[];
validator: (args) => object;
}
}
interface IntlObject {
id: string;
defaultMessage: string;
}
interface CTBFormSection {
sectionTitle: IntlObject;
items: CTBFormInput[];
}
interface CTBFormInput {
name: string;
description: InltObject;
type: string;
intlLabel: IntlObject;
}
```
For the admin, we will expose a new `customFields` object with a `register` method on the `StrapiApp` instance. The custom field can then be added to Strapi during the admin [bootstrap lifecycle](https://docs.strapi.io/developer-docs/latest/developer-resources/plugin-api-reference/admin-panel.html#bootstrap) by providing the following object to `customFields.register()`.
To register a custom field to the admin panel, see [documentation](https://docs.strapi.io/developer-docs/latest/development/custom-fields.html#registering-a-custom-field-in-the-admin-panel).
Note: You can only share a custom field by packaging it into a plugin.