Skip to main content

ForeignInlineList

Foreign inline list plugin allows to display a list (table) of items from a foreign table in the show view.

Usage

Import plugin:

npm i @adminforth/foreign-inline-list --save
./index.ts
import ForeignInlineListPlugin from '@adminforth/foreign-inline-list';
import { AdminForthResource, AdminForthResourceColumn } from 'adminforth';

In Getting Started we created a 'aparts' resource which has a field 'realtor_id'. This field refers to record from 'users' resource. This means that we can display a list of apartments in the user's show view.

Add to your 'users' resource configuration the plugin instance:

./resources/users.ts
{ 
...
resourceId: 'users',
...
plugins: [
new ForeignInlineListPlugin({
foreignResourceId: 'aparts',
modifyTableResourceConfig: (resourceConfig: AdminForthResource) => {
// hide column 'square_meter' from both 'list' and 'filter'
const column = resourceConfig.columns.find((c: AdminForthResourceColumn) => c.name === 'square_meter')!.showIn = [];
resourceConfig.options!.listPageSize = 1;
// feel free to console.log and edit resourceConfig as you need
},
}),
],
}

You can use modifyTableResourceConfig callback to modify what columns to show in the list and filter of the foreign table.

alt text

See API Reference for more all options.