codeclipse/sortable-behavior-bundle

Provides a way to sort your admin listing

Maintainers

Details

github.com/codeclipse/sortable-behavior-bundle

Homepage

Source

Installs: 38

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 76

Type:symfony-bundle

v2.0 2022-06-26 10:02 UTC

Requires

Requires (Dev)

Suggests

Conflicts

MIT 9f06bad865d6fefbc26a6d11d01c643a4f40cf6b

adminsonatasortable

This package is auto-updated.

Last update: 2024-03-26 14:10:43 UTC

README

This package is a fork of https://github.com/pix-digital/pixSortableBehaviorBundle

SonataAdminBundle implementation

The SonataAdminBundle provides a cookbook article here :

https://github.com/sonata-project/SonataAdminBundle/blob/4.x/docs/cookbook/recipe_sortable_listing.rst

Configuration

By default, this extension works with Doctrine ORM, but you can choose to use Doctrine MongoDB by defining the driver configuration :

# config/packages/codeclipse_sortable_behavior.yaml
codeclipse_sortable_behavior:
    db_driver: mongodb # default value : orm
    position_field:
        default: sort #default value : position
        entities:
            AppBundle\Entity\Foobar: order
            AppBundle\Entity\Baz: rang
    sortable_groups:
        entities:
            AppBundle\Entity\Baz: [ group ]

Use a draggable list instead of up/down buttons

In order to use a draggable list instead of up/down buttons, change the template in the move action to @CodeclipseSortableBehavior/Default/_sort_drag_drop.html.twig.

<?php

    // ClientAdmin.php
    protected function configureListFields(ListMapper $listMapper)
    {
        $listMapper
            ->addIdentifier('name')
            ->add('enabled')
            ->add(ListMapper::NAME_ACTIONS, null, [
                'actions' => [
                    'move' => [
                        'template' => '@AppBundle/Admin/_sort_drag_drop.html.twig',
                        'enable_top_bottom_buttons' => false, // enabled by default
                    ],
                ],
            ])
        ;
    }

Also include the JavaScript needed for this to work, in your theme.yml file, add these two lines:

    //...
    javascripts:
        - bundles/codeclipsesortablebehavior/vendor/jquery-ui.min.js // if you haven't got jQuery UI yet.
        - bundles/codeclipsesortablebehavior/js/app.js

Adding the JavaScript and the template, will give you the possibility to drag items in a tablelist. In case you need it, this plugin fires to jQuery events when dragging is done on the $(document) element, so if you want to add custom notification, that is possible. Also, when dragging the <body> gets an is-dragging class. This class is removed when you stop dragging. This could by quite handy if you have some custom js/css.

codeclipseSortableBehaviorBundle.success
codeclipseSortableBehaviorBundle.error

Disable top and bottom buttons

<?php

    // ClientAdmin.php
    protected function configureListFields(ListMapper $listMapper)
    {
        $listMapper
            ->addIdentifier('name')
            ->add('enabled')
            ->add(ListMapper::NAME_ACTIONS, null, [
                'actions' => [
                    'move' => [
                        'template' => '@CodeclipseSortableBehavior/Default/_sort_drag_drop.html.twig',
                        'enable_top_bottom_buttons' => false,
                    ],
                ],
            ])
        ;
    }