How to order record of relationship fields?

[cod3rshotout]

I have created a relationship field and I need a way to reoder items like a repeater:

 CRUD::field([
        'name' => 'paths',
        'label' => __('backend/museum.info.paths'),
        'type' => 'relationship',
        'entity' => 'paths',
        'attribute' => 'name',
        'pivot' => true,
        'multiple' => true,
        'model' => 'App\Models\MuseumPath',
        'inline_create' => ['entity' => 'museum-path'],
        'wrapper' => [
            'class' => 'form-group col-md-12'
        ],
        'subfields' => [],
        'pivotSelect' => [
            'label' =>  __('backend/museum.paths.select_path'),
            'inline_create' => [
                'entity' => 'museum-path',
                'modal_route' => route('museum-path-inline-create'),
            ],
            'data_source' => route('museum.fetchMuseumPaths'),
        ],
        'tab' => $paths_tab,
    ]);

how can I do that?

[backpack-ai-bot[bot]]

To order records in a relationship field in Backpack, you can use the orderColumn attribute. This feature allows you to add reordering functionality similar to a repeatable field. Here's how you can modify your code to include this:

CRUD::field([
    'name' => 'paths',
    'label' => __('backend/museum.info.paths'),
    'type' => 'relationship',
    'entity' => 'paths',
    'attribute' => 'name',
    'pivot' => true,
    'multiple' => true,
    'model' => 'App\Models\MuseumPath',
    'inline_create' => ['entity' => 'museum-path'],
    'wrapper' => [
        'class' => 'form-group col-md-12'
    ],
    'subfields' => [],
    'pivotSelect' => [
        'label' =>  __('backend/museum.paths.select_path'),
        'inline_create' => [
            'entity' => 'museum-path',
            'modal_route' => route('museum-path-inline-create'),
        ],
        'data_source' => route('museum.fetchMuseumPaths'),
    ],
    'tab' => $paths_tab,
    'orderColumn' => 'order', // Add this line
]);

By adding the 'orderColumn' => 'order' attribute, you're telling Backpack to use a column named 'order' in your pivot table to manage the ordering of the relationship items.

Here are some important points to note:

1. You need to add an 'order' column to your pivot table if it doesn't already exist.
2. Make sure to add the 'order' column to your withPivot() statement in your relationship definition.
3. This will add up and down arrows next to each row in the relationship field, allowing you to reorder the items.

If you want more control over the ordering, you can also use the following syntax:

'orderColumn' => ['name' => 'order', 'type' => 'number', 'attributes' => ['data-reorder-input' => true]]

This will add a visible number input field for the order, in addition to the up and down arrows.

Source: Backpack Docs

Remember to update your database schema and model relationships accordingly to support this new ordering functionality.

ℹ️ Please note our AI Bot does not reply to follow-ups, this will be the only AI answer in this thread. If the AI helped you find the answer, please mark it as answered or write details below so it can learn. Then close the conversation. If not, please give more information for when a human reads this. ℹ️

Relevant sources:

Github Issue (closed): How to customize relationship pivot field orderBy
Add orderColumn to repeatable to work with pivot orders
Github Issue (closed): [Feature Request] Add support reorder repeatable rows
Github Issue (closed): [WIP][REFERENCE] Relationships know limitations / edge cases
Github Issue (closed): [4.1] Relationship field does not work inside repeatable
Github Issue (closed): [Bug] Ordering issue in inlinecreate n-n relationship with fetch ajax
Github Issue (closed): ajaxRequest order by relation column
Fields|repeatable PRO Part 3
Github Issue (closed): [4.1.0][Bug] Problems with relationship field type
Use of Repeatable inside Relationship
Github Issue (closed): [Bug] Repeatable with field select2_multiple and relations
Github Issue (closed): Reorder fields not working and multiple checkbox not selecting second in repeatable fields
Github Issue (closed): reorder items inside the repeatable field.

[karandatwani92]

Hey @cod3rshotout

The bot is partially correct. Follow these steps to reorder the subfield rows of the relationship field:

1. You need to add an 'order' column to your pivot table if it doesn't already exist.
2. Make sure to add the 'order' column to your withPivot() statement in your relationship definition.

public function owners()
{
    return $this->belongsToMany(\App\Models\PetShop\Owner::class)->withPivot(['role', 'order']);
}

3. Now add the reorder attribute to the field definition

CRUD::field('owners')
  ->subfields([['name' => 'role', 'type' => 'text']])
+  ->reorder('order');

This will add up and down arrows next to each row in the relationship field, allowing you to reorder the items. You can also check a diff here of a branch I used to test before answering.

[karandatwani92]

The docs had this reorder attribute in the repeatable field definition.
I'll update the docs with the same for the 'relationship' field for better clarity.

Thanks for pointing out and opening the discussion.