m2mtech/ux-navigation

Twig/UX extensions for common navigation widgets for symfony.

v2.0.0 2022-02-23 14:44 UTC

Requires

• php: >=7.2.5
• ext-intl: *
• symfony/dependency-injection: ^5.4|^6.0
• symfony/intl: ^5.4|^6.0
• symfony/twig-bundle: ^5.4|^6.0

Requires (Dev)

• phpstan/phpstan: ^1.4
• phpunit/phpunit: ^8.5.22|^9.5
• roave/security-advisories: dev-latest
• symfony/phpunit-bridge: ^5.4|^6.0
• symfony/webpack-encore-bundle: ^1.14
• symplify/easy-coding-standard: ^10.1

MIT

• Martin Mandl

• symfony
• twig
• extension
• navigation
• twig extension
• ux
• language selector
• dark mode
• symfony-ux

README

This bundle provides Twig extensions for common navigation widgets as well as their stimulus controllers wired for symfony UX.

Installation

composer require m2mtech/ux-navigation

If you are not using Flex enable the bundle:

// config/bundles.php

return [
    // ...
    M2MTech\UxNavigation\M2MTechUxNavigationBundle::class => ['all' => true],
];

If you want to use the bundled stimulus controllers install the Javascript dependencies and compile them:

yarn install --force
yarn encore dev

Usage

Function	Description
m2mDarkModeSelector()	Renders dark mode selector.
m2mLanguageSelector()	Renders links from the current path to switch languages.

Documentation can be found in the ./docs directory.

Testing

This package has been developed for php 7.4 with compatibility tested for php 7.2 to 8.1.

composer test

# or the Javascript respectively  
cd src/Resources/assets; yarn test

Changelog

Please see CHANGELOG for more information about recent changes.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• All Contributors

License

The MIT License (MIT). Please see License File for more information.