# Display Builder

A display building tool by the [UI Suite](https://www.drupal.org/project/ui_suite) team:

- **Design system native**: fully use your design system (components, style utilities, icons, themes/modes, CSS variables...) directly in Drupal without the burden of compatibility layers
- **Unified**: can be used instead of Layout Builder for entity view displays, Block Layout for page displays, and as a replacement of the Views' display building feature.
- **Modern**: A builder for the world of today, with powerful features (dynamic previews, pattern presets, real-time collaboration, deep integration with Drupal APIs...)

## Installation

Install as you would normally install a contributed Drupal module.
See: [Installing Modules](https://www.drupal.org/docs/extending-drupal/installing-modules) for further information.

!!! warning "Development stage"
  The module is still in heavy development and [some extra steps may be needed](./docs/contributing.md).

## Tests

E2e tests are done with [Playwright](https://playwright.dev/docs/intro#installing-playwright).

Tests are located in `tests/src/Playwright/tests`.

To install Playwright run from this module folder:

```shell
npm install
npx playwright install
```

To run tests locally, copy and adapt the `.env.dist` file as `.env`, fill the values and run:

```shell
npm install
npx playwright test
```

## Contributing

Join us on slack [#display_builder](https://drupal.slack.com/archives/C092EUNPCRW).

See [documentation](./docs/contributing.md).

## Documentation (Work in progress)

See [online documentation](https://project.pages.drupalcode.org/display_builder) or local [docs/index.md](./docs/index.md).

## Maintainers

Current maintainers:

- Jean Valverde - [mogtofu33](https://www.drupal.org/u/mogtofu33)
- Mikael Meulle - [just_like_good_vibes](https://www.drupal.org/u/just_like_good_vibes)
- Pierre Dureau - [pdureau](https://www.drupal.org/u/pdureau)

Supporting organizations:

- [Beyris](https://www.drupal.org/beyris) - We are leading impactful open-source
  projects and we are providing coding, training, audit and consulting.
- You want to support us? Contact us on slack [#display_builder](https://drupal.slack.com/archives/C092EUNPCRW)
