-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
213 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,115 @@ | ||
| --- | ||
| title: Blocks Field | ||
| label: Blocks | ||
| order: 20 | ||
| order: 30 | ||
| --- | ||
|
|
||
| get out | ||
| <Banner > | ||
| The Blocks field type is <strong>incredibly powerful</strong> and can be used as a <em>layout builder</em> as well as to define any other flexible content model you can think of. It stores an array of objects, where each object must match the shape of one of your provided block configs. | ||
| </Banner> | ||
|
|
||
| **Example uses:** | ||
|
|
||
| - A layout builder tool that grants editors to design highly customizable page or post layouts. Blocks could include configs such as `Quote`, `CallToAction`, `Slider`, `Content`, `Gallery`, or others. | ||
| - A form builder tool where available block configs might be `Text`, `Select`, or `Checkbox`. | ||
| - Virtual event agenda "timeslots" where a timeslot could either be a `Break`, a `Presentation`, or a `BreakoutSession`. | ||
|
|
||
| **Admin panel screenshot:** | ||
|
|
||
|  | ||
|
|
||
| ### Field config | ||
|
|
||
| | Option | Description | | ||
| | ---------------- | ----------- | | ||
| | **`name`** * | To be used as the property name when stored and retrieved from the database. | | ||
| | **`label`** | Used as a heading in the Admin panel and to name the generated GraphQL type. | | ||
| | **`blocks`** * | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field. | | ||
| | **`validate`** | Provide a custom validation function. [More](/docs/fields/overview#validation) | | ||
| | **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. | | ||
| | **`hooks`** | Provide field-level hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | ||
| | **`access`** | Provide field-level access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | ||
| | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin panel. | | ||
| | **`defaultValue`** | Provide an array of block data to be used for this field's default value. | | ||
| | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. || **`required`** | Require this field to have a value. | | ||
| | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | ||
| | **`labels`** | Customize the block row labels appearing in the Admin dashboard. | | ||
| | **`admin`** | Admin-specific configuration. See below for [more detail](/docs/fields/array#admin). | | ||
|
|
||
| *\* An asterisk denotes that an option is required.* | ||
|
|
||
| ### Block configs | ||
|
|
||
| Blocks are defined as separate configs of their own. | ||
|
|
||
| <Banner type="success"> | ||
| <strong>Tip:</strong><br /> | ||
| Best practice is to define each block config in its own file, and then import them into your Blocks field as necessary. This way each block config can be easily shared between fields. For instance, using the "layout builder" example, you might want to feature a few of the same blocks in a Post collection as well as a Page collection. Abstracting into their own files trivializes their reusability. | ||
| </Banner> | ||
|
|
||
| | Option | Description | | ||
| | ---------------- | ----------- | | ||
| | **`slug`** * | Identifier for this block type. Will be saved on each block as the `blockType` property. | | ||
| | **`fields`** * | Array of fields to be stored in this block. | | ||
| | **`labels`** | Customize the block labels that appear in the Admin dashboard. Also used to name corresponding GraphQL schema types. | | ||
| | **`imageURL`** | Provide a custom image thumbnail to help editors identify this block in the Admin UI. | | ||
| | **`imageAltText`** | Customize this block's image thumbnail alt text. | | ||
|
|
||
| #### Required, auto-generated data per block | ||
|
|
||
| In addition to the field data that you define on each block, Payload will store two additional required properties on each block: | ||
|
|
||
| **`blockType`** | ||
|
|
||
| The `blockType` is saved as the slug of the block that has been selected. | ||
|
|
||
| **`blockName`** | ||
|
|
||
| The Admin panel provides each block with a `blockName` field which optionally allows editors to label their blocks for better editability and readability. | ||
|
|
||
| ### Full example | ||
|
|
||
| `collections/ExampleCollection.js` | ||
| ```js | ||
| { | ||
| slug: 'example-collection', | ||
| fields: [ | ||
| { | ||
| name: 'layout', // required | ||
| type: 'blocks', // required | ||
| label: 'layout', | ||
| minRows: 1, | ||
| maxRows: 20, | ||
| labels: { | ||
| singular: 'Layout', | ||
| plural: 'Layouts', | ||
| }, | ||
| blocks: [ // required | ||
| { | ||
| slug: 'Quote', // required | ||
| imageURL: 'https://google.com/path/to/image.jpg', | ||
| imageAltText: 'A nice thumbnail image to show what this block looks like', | ||
| fields: [ // required | ||
| { | ||
| name: 'text', | ||
| label: 'Quote Text', | ||
| type: 'text', | ||
| required: true, | ||
| }, | ||
| { | ||
| name: 'text', | ||
| label: 'Quotee', | ||
| type: 'text', | ||
| }, | ||
| ] | ||
| }, | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| ### Admin | ||
|
|
||
| This field features default admin options at this time. For more on default admin options, [click here](/docs/fields/overview#admin-options). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters