Skip to content
  • About
    • What is Symfony?
    • Community
    • News
    • Contributing
    • Support
  • Documentation
    • Symfony Docs
    • Symfony Book
    • Screencasts
    • Symfony Bundles
    • Symfony Cloud
    • Training
  • Services
    • SensioLabs Professional services to help you with Symfony
    • Platform.sh for Symfony Best platform to deploy Symfony apps
    • SymfonyInsight Automatic quality checks for your apps
    • Symfony Certification Prove your knowledge and boost your career
    • Blackfire Profile and monitor performance of your apps
  • Other
  • Blog
  • Download
sponsored by SensioLabs
  1. Home
  2. Documentation
  3. Frontend
  4. Create a UX bundle
  • Documentation
  • Book
  • Reference
  • Bundles
  • Cloud

Table of Contents

  • composer.json file
  • Assets location
  • package.json file

Create a UX bundle

Edit this page

Create a UX bundle

Tip

Before reading this, you may want to have a look at Best Practices for Reusable Bundles.

Here are a few tricks to make your bundle install as a UX bundle.

composer.json file

Your composer.json file must have the symfony-ux keyword:

1
2
3
{
    "keywords": ["symfony-ux"]
}

Assets location

Your assets must be located in one of the following directories, with a package.json file so Flex can handle it during install/update:

  • /assets (recommended)
  • /Resources/assets
  • /src/Resources/assets

package.json file

Your package.json file must contain a symfony config with controllers defined, and also add required packages to the peerDependencies:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "name": "@acme/feature",
    "version": "1.0.0",
    "symfony": {
        "controllers": {
            "slug": {
                "main": "dist/controller.js",
                "fetch": "eager",
                "enabled": true,
                "autoimport": {
                    "dist/bootstrap4-theme.css": false,
                    "dist/bootstrap5-theme.css": true
                }
            }
        }
    },
    "peerDependencies": {
        "@hotwired/stimulus": "^3.0.0",
        "slugify": "^1.6.5"
    }
}

In this case, the file located at [assets directory]/dist/controller.js will be exposed.

Tip

You can either write raw JS in this dist/controller.js file, or you can e.g. write your controller with TypeScript and transpile it to JavaScript.

Here is an example to do so:

  1. Add the following to your package.json file:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "scripts": {
        "build": "babel src --extensions .ts -d dist"
    },
    "devDependencies": {
        "@babel/cli": "^7.20.7",
        "@babel/core": "^7.20.12",
        "@babel/plugin-proposal-class-properties": "^7.18.6",
        "@babel/preset-env": "^7.20.2",
        "@babel/preset-typescript": "^7.18.6",
        "@hotwired/stimulus": "^3.2.1",
        "typescript": "^4.9.5"
    }
}
  1. Run either npm install or yarn install to install the new dependencies.
  2. Write your Stimulus controller with TypeScript in src/controller.ts.
  3. Run npm run build or yarn run build to transpile your TypeScript controller into JavaScript.

To use your controller in a template (e.g. one defined in your bundle) you can use it like this:

1
2
3
4
5
6
7
8
9
10
<div
    {{ stimulus_controller('acme/feature/slug', { modal: 'my-value' }) }}
    {#
        will render:
        data-controller="acme--feature--slug"
        data-acme--feature--slug-modal-value="my-value"
    #}
>
    ...
</div>

Don't forget to add symfony/webpack-encore-bundle:^1.12 as a composer dependency to use Twig stimulus_* functions.

Tip

Controller Naming: In this example, the name of the PHP package is acme/feature and the name of the controller in package.json is slug. So, the full controller name for Stimulus will be acme--feature--slug, though with the stimulus_controller() function, you can use acme/feature/slug.

Each controller has a number of options in package.json file:

Option Description
enabled Whether the controller should be enabled by default.
main Path to the controller file.
fetch How controller & dependencies are included when the page loads. Use eager (default) to make controller & dependencies included in the JavaScript that's downloaded when the page is loaded. Use lazy to make controller & dependencies isolated into a separate file and only downloaded asynchronously if (and when) the data-controller HTML appears on the page.
autoimport List of files to be imported with the controller. Useful e.g. when there are several CSS styles depending on the frontend framework used (like Bootstrap 4 or 5, Tailwind CSS...). The value must be an object with files as keys, and a boolean as value for each file to set whether the file should be imported.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version
    We stand with Ukraine.
    Version:

    Symfony 6.2 is backed by

    Symfony 6.2 is backed by

    The life jacket for your team and your project

    The life jacket for your team and your project

    Check Code Performance in Dev, Test, Staging & Production

    Check Code Performance in Dev, Test, Staging & Production

    Symfony footer

    ↓ Our footer now uses the colors of the Ukrainian flag because Symfony stands with the people of Ukraine.

    Avatar of Gun5m0k3, a Symfony contributor

    Thanks Gun5m0k3 for being a Symfony contributor

    2 commits • 4 lines changed

    View all contributors that help us make Symfony

    Become a Symfony contributor

    Be an active part of the community and contribute ideas, code and bug fixes. Both experts and newcomers are welcome.

    Learn how to contribute

    Symfony™ is a trademark of Symfony SAS. All rights reserved.

    • What is Symfony?

      • Symfony at a Glance
      • Symfony Components
      • Case Studies
      • Symfony Releases
      • Security Policy
      • Logo & Screenshots
      • Trademark & Licenses
      • symfony1 Legacy
    • Learn Symfony

      • Symfony Docs
      • Symfony Book
      • Reference
      • Bundles
      • Best Practices
      • Training
      • eLearning Platform
      • Certification
    • Screencasts

      • Learn Symfony
      • Learn PHP
      • Learn JavaScript
      • Learn Drupal
      • Learn RESTful APIs
    • Community

      • SymfonyConnect
      • Support
      • How to be Involved
      • Code of Conduct
      • Events & Meetups
      • Projects using Symfony
      • Downloads Stats
      • Contributors
      • Backers
    • Blog

      • Events & Meetups
      • A week of symfony
      • Case studies
      • Cloud
      • Community
      • Conferences
      • Diversity
      • Documentation
      • Living on the edge
      • Releases
      • Security Advisories
      • SymfonyInsight
      • Twig
      • SensioLabs
    • Services

      • SensioLabs services
      • Train developers
      • Manage your project quality
      • Improve your project performance
      • Host Symfony projects

      Deployed on

    Follow Symfony

    Search by Algolia