Skip to content

Fix misleading component key documentation about the name key being inheritable #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juliendargelos wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix misleading component key documentation about the name key being inheritable #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ Fields define the structure and data types for your content entries or [componen
| **`label`** | `string` | Display name for the field. This is what is displayed in the edit form. If omitted, the `name` is used. |
| **`description`** | `string` | Help text displayed below the field in the form. |
| **`type`** | `string` | Defines the type of field. Can be a single type name: **[block](/docs/configuration/block-field)**, **[boolean](/docs/configuration/boolean-field)**, **[code](/docs/configuration/code-field)**, **[date](/docs/configuration/date-field)**, **[file](/docs/configuration/file-field)**, **[image](/docs/configuration/image-field)**, **[number](/docs/configuration/number-field)**, **[object](/docs/configuration/object-field)**, **[reference](/docs/configuration/reference-field)**, **[rich-text](/docs/configuration/rich-text-field)**, **[select](/docs/configuration/select-field)**, **[string](/docs/configuration/string-field)**, **[text](/docs/configuration/text-field)** or **[uuid](/docs/configuration/uuid-field)**. If undefined, it defaults to `text` unless `fields` is defined (then it defaults to `object`). |
| **`component`** | `string` | Allows a field to inherit its properties (like `type`, `label`, nested `fields`, `options`, etc.) from a defined [Component](#components). The value should be the name (key) of the component to inherit from. Properties defined directly on the field (like `name`, `label`, `required`) will override those inherited from the component. The `type` inherited from the component takes precedence over any `type` defined on the field itself. |
| **`component`** | `string` | Allows a field to inherit its properties (like `type`, `label`, nested `fields`, `options`, etc.) from a defined [Component](#components). The value should be the name (key) of the component to inherit from. Properties defined directly on the field (like `label`, `required`) will override those inherited from the component. The `type` inherited from the component takes precedence over any `type` defined on the field itself. |
| **`default`** | (any) | Default value for the field when a new entry is created. |
| **`list`** | `boolean` or `object` | If truthy, the field is an array of values (of the type defined for the field). [See the "List" section below](#list). |
| **`hidden`** | `boolean` | If `true`, the field will not be displayed in the form but will be saved. It is usually used with `default` to set a required field that shouldn't be edited by users, like for example the language of a post (`lang: en-US`). |
Expand Down