eaf

The Entity Attributes Field (EAF) module provides a field definition that allows you to add custom attributes to entities, fields, or field items.

These attributes are not part of the actual content, but rather provide additional metadata or configuration options that can enhance the display, behavior, or functionality of the content.

What are Attributes?

Attributes are additional settings or options that can be applied to content entities, fields, or field items. They are not part of the core content, but rather provide a way to customize or extend the behavior of the content.

Attributes are a part of the content entity, but they are not intended to be searched, indexed or displayed as part of the main content. Instead, they provide additional metadata or configuration options that enhance the content, but are not relevant to search queries.

Examples of attributes include

- Alignment options for images (e.g., left, right, center)
- Display settings for paragraph titles (e.g., include in table of contents, hide title)
- Background settings for sections (e.g., select from predefined background colors or images)
- Spacing or padding options for fields or field items
- Mark a link field to show as a button not a link or just mark only one link, not all
- Add custom class to your entity by a taxonomy vocabulary

How it Works:

- Add the attribute field to an entity type (e.g., node, paragraph, etc.).
- Configure the available attribute plugins for that entity or field.
- When creating or editing content, users can select and configure the available attributes for that entity or field.
- The attribute data is stored in the database as JSON, allowing for easy retrieval and manipulation.

The EAF module uses attribute plugins to provide these custom attributes. Attribute plugins are small pieces of code that define a specific attribute and its behavior.

Benefits of Using EAF Module

The EAF module provides several benefits, including:

- Flexibility: Easily add custom attributes to content entities, fields, or field items without modifying the underlying content.
Reusability: Attribute plugins can be reused across multiple content types, fields, or field items.
Extensibility: Developers can create custom attribute plugins to meet specific use cases or requirements.
By using the EAF module, you can provide a more customized and flexible content creation experience for your users, while also streamlining your development workflow.

Key Features

- Add custom attributes to entities, fields, and field items
- Utilize attribute plugins for modular and reusable attribute logic
- Compatible with various entity types and field types