Display tabular data beautifully in a simple way.

This component like all other BladewindUI components is simple to use with a few options to customise the component to suit your app needs. A BladewindUI table consists of two parts. The table header and the table body.

        
             <x-bladewind::table>
                <x-slot name="header">
                    <th>Name</th>
                    <th>Department</th>
                    <th>Email</th>
                </x-slot>
                <tr>
                    <td>Alfred Rowe</td>
                    <td>Outsourcing</td>
                    <td>alfred@therowe.com</td>
                </tr>
                <tr>
                    <td>Michael K. Ocansey</td>
                    <td>Tech</td>
                    <td>kabutey@gmail.com</td>
                </tr>
            </x-bladewind::table>
        
    

By default the table component does not display a border around the table. You can enable this by setting. has_border="true"

        
             <x-bladewind::table
                has_border="true">
                ...
            </x-bladewind::table>
        
    

No Gaps

By default the BladewindUI table rows are displayed with wide gaps to place more emphasis on each row and it’s content. Each row also has a default hover effect that highlights the left and right borders of the row. These can both be turned off.

To remove the wide gaps between the table rows you need to set the divider attribute to thin, like this, divider="thin".

        
             <x-bladewind::table
                divider="thin">
                <x-slot name="header">
                    <th>Name</th>
                    ...
                </x-slot>
                ...
            </x-bladewind::table>
        
    

No Divider

It is also possible to completely turn off the divider lines.

To remove the divider completely, set the divided attribute to false, like this, divided="false".

        
             <x-bladewind::table
                divided="false">
                <x-slot name="header">
                    <th>Name</th>
                    ...
                </x-slot>
                ...
            </x-bladewind::table>
        
    

No Hover Effect

To remove the beautiful green side border effect when users hover on each row, set the hover attribute to false, like this, has_hover="false".

        
                <x-bladewind::table
                    has_hover="false"
                    divider="thin">

                <x-slot name="header">
                    <th>Name</th>
                    ...
                </x-slot>
                ...
            </x-bladewind::table>
        
    

Compact

If the table feels too airy and spaced, there is a compact="true" attribute to tighten things up.

        
                <x-bladewind::table
                    compact="true"
                    divider="thin">

                <x-slot name="header">
                    <th>Name</th>
                    ...
                </x-slot>
                ...
            </x-bladewind::table>
        
    

Striped Table

Design experts argue that it is sometimes easier for users to visually scan tabular data if the table has striped rows. We are not challenging the experts. We’ve however made it possible for you to make your BladewindUI tables have striped rows. Set striped="true" on the table component to get a striped table.

        
            <x-bladewind::table
                striped="true"
                divider="thin">

                <x-slot name="header">
                    <th>Name</th>
                    ...
                </x-slot>
                ...
            </x-bladewind::table>
        
    

Celled Table

If you want your tables looking like an excel spreadsheet with each cell having all round borders, set celled="true".

        
            <x-bladewind::table celled="true">

                <x-slot name="header">
                    <th>Name</th>
                    ...
                </x-slot>
                ...
            </x-bladewind::table>
        
    

Cells for Totals

Accountants have this interesting habit of double underlining their totals. If that’s something that interests you, apply the class double-underline to the td that holds the total value you want double underlined.

        
            <x-bladewind::table striped="true" divider="thin">

                <x-slot name="header">
                    <th>Name</th>
                    ...
                </x-slot>
                ...
                <tr>
                    <td colspan="2" class="text-right"></td>
                    <td class="double-underline text-right">
                        7,300.00
                    </td>
                </tr>
            </x-bladewind::table>
        
    

Table With Drop Shadow

You can add a subtle shadow effect to your BladewindUI tables by setting has_shadow="true"

        
            <x-bladewind::table
                has_shadow="true"
                striped="true"
                divider="thin">

                <x-slot name="header">
                    <th>Name</th>
                    ...
                </x-slot>
                ...
            </x-bladewind::table>
        
    

Selectable Rows

There are cases you may want to show users which rows they have selected. You can achieve that by setting selectable="true" on the table. Now, any time a user clicks on a row it will be selected. Clicking on multiple rows will select them all. Clicking on a row that is already selected will unselect it. The cursor changes to cursor-pointer when a table is defined as selectable. Cool shortcuts like Ctrl+Click or Shift+Click do not work here.

        
            <x-bladewind::table selectable="true" divider="thin">
                <x-slot name="header">
                    <th>Item</th>
                    <th>Quantity</th>
                    <th>Unit Price (GHS)</th>
                </x-slot>
                <tr>
                    <td>Office furniture</td>
                    <td class="text-center">2</td>
                    <td class="text-right">4,300.00</td>
                </tr>
                ...
            </x-bladewind::table>
        
    

Checkable

We can take the selectable tables one step further by introducing checkboxes for every row. This is achieved by setting checkable="true" on the table. Each row should now have a checkbox injected as the first column. If a table heading exists, a checkbox is also injected as the first column in the table heading. This becomes the master checkbox for checking or unchecking all other checkboxes at once. The state changes to a partial selected checkbox if some of the checkboxes are checked.

        
            <x-bladewind::table selectable="true" checkable="true" divider="thin">
                <x-slot name="header">
                    <th>Item</th>
                    <th>Quantity</th>
                    <th>Unit Price (GHS)</th>
                </x-slot>
                <tr>
                    <td>Office furniture</td>
                    <td class="text-center">2</td>
                    <td class="text-right">4,300.00</td>
                </tr>
                ...
            </x-bladewind::table>
        
    

Having selectable table rows definitely means you will want to do something with the selected values. You will need to append unique IDs (data-id="your-uuid-value") to your table rows in order for Bladewind to recognize and return them.

You will also need to provide a name for the table. This will be the name of the input field that holds the comma separated list of table row IDs that are selected.

        
            <x-bladewind::table selectable="true" checkable="true" divider="thin"
                name="office_supplies">
                <x-slot name="header">
                    <th>Item</th>
                    <th>Quantity</th>
                    <th>Unit Price (GHS)</th>
                </x-slot>
                <tr data-id="1">
                    <td>Office furniture</td>
                    <td class="text-center">2</td>
                    <td class="text-right">4,300.00</td>
                </tr>
                <tr data-id="2">
                    <td>HP Laser Jet Printer</td>
                    <td class="text-center">2</td>
                    <td class="text-right">4,300.00</td>
                </tr>
                ...
            </x-bladewind::table>
        
    

We now have a hidden input injected on the page right after the table. <input type="hidden" name="office_supplies" class="office_supplies" />. We can now access the value of this input field using JavaScript or via a form submission if your table is placed within a form. In the example below we delete all table rows that are selected. Select more than one row.

        
    <x-bladewind::card reduce_padding="true">
        <!-- the delete button -->
        <div class="office-supplies-actions p-3 bg-gray-100/50 rounded-lg hidden">
            <x-bladewind::button size="tiny"
                type="secondary" outline="true"
                icon="trash" color="red"
                onclick="deleteRows()">
                Delete
            </x-bladewind::button>
        </div>

        <x-bladewind::table selectable="true" divider="thin"
            checkable="true"
            name="office_supplies">
            <x-slot:header>
                <th>Item</th>
                <th class="!text-center">Quantity</th>
                <th class="!text-right">Unit Price (GHS)</th>
            </x-slot:header>
            <tr data-id="12">
                <td>Office furniture</td>
                <td class="text-center">2</td>
                <td class="text-right">4,300.00</td>
            </tr>
            ...
        </x-bladewind::table>
    </x-bladewind::card>
        
    

The above code will draw the table and let Bladewind do its checkboxing magic. You will however, need to write the code for working with the values of the selected table rows. The deleteRows() Javascript function below is what handles deleting of the rows selected by the user from the example above. deleteRow() is not a BladewindUI helper function.

        
    // domEl(), domEls() and hide() are BladewindUI helper functions
    deleteRows = () => {
        // Our table is named 'office_supplies' so input.office_supplies is
        // the hidden field Bladewind will write IDs of all selected rows to
        const selectedRows = domEl('input.office_supplies').value.split(',');

        // next we loop over all the rows of our 'office_supplies' table and
        // hide any row that's having the value of its 'data-id' attribute
        // in the selected rows array
        const tableRows = domEls('table.office_supplies tr');
        tableRows.forEach(row => {
            if(selectedRows.indexOf(row.getAttribute('data-id')) !== -1) {
                hide(row, true);
                hide('.office-supplies-actions');
                domEl('input.office_supplies').value = '';
            }
        });
    }
        
    

<x-bladewind::table selectable="true" divider="thin"
    checkable="true"
    selected_value="2,4,19,23"
    name="office_supplies">
    ...

Display a Table From Dynamic Data

There is no point manually building a table tediously when you have an array that contains everything you want to display as a table. The table component has a data attribute that accepts a json encoded array. The component builds its table headings using the array keys.

Let us consider the array below and its resultant table.

        
            $staff = [
                [   'id' => 1,
                    'first_name' => 'Michael',
                    'last_name' => 'Ocansey',
                    'department' => 'Engineering',
                    'marital_status' => 1
                ],
                [
                    'id' => 2,
                    'first_name' => 'Alfred',
                    'last_name' => 'Rowe',
                    'department' => 'Engineering',
                    'marital_status' => 1
                ],
                [
                    'id' => 3,
                    'first_name' => 'Abigail',
                    'last_name' => 'Edwin',
                    'department' => 'Engineering',
                    'marital_status' => 0
                ],
            ];
        
    

        
            <x-bladewind::table :data="$staff" />
        
    

        
            <x-bladewind::table data="{{ json_encode($staff) }}" />
        
    

As you can tell from the above example, the component simply picks the array passed to it and generates a table. You can apply all the table attributes to remove the hover effect, remove the gaps or even make the table striped.

Excluding and Including Columns

By default, the table picks the keys of the array and generates its table headings. Any key with underscores will be replaced with spaces. first_name becomes first name. An API will return staff data with the ID of each user, but it is rare to see the IDs displayed in a table. The table component allows you to exclude some columns using the exclude_columns attribute. There is also the include_columns attribute that lets you specify the only columns to be displayed.

If you have an array with 20 fields and you want to display 5 out of the 20 fields, it will be easier to specify the 5 columns in the include_columns attribute rather than specifying 15 columns in the exclude_columns attribute. Let us exclude id and marital_status from our table above.

    <x-bladewind::table
        exclude_columns="id, marital_status"
        :data="$staff" />

Displaying Action Icons

Using the table component with dynamic data allows you to specify some extra cool attributes. You can show action icons by passing a json encoded array in the action_icons attribute. Each action icon can have the name of the icon, the icon colour (default is the secondary button colour), a tooltip and the click action of the icon. The icons will be displayed in the order they are entered into the array.

    $action_icons = [
        "icon:chat | tip:send message | color:green | click:sendMessage('{first_name}')",
        "icon:pencil | click:redirect('/user/{id}')",
        "icon:trash | color:red | click:deleteUser({id}, '{first_name}')",
    ];

    <x-bladewind::table
        exclude_columns="id, marital_status"
        divider="thin"
        :action_icons="$action_icons"
        :data="$staff" />

The icons are displayed from the $action_icons array above. Let us analyze the first line of the $action_icons array. Note how each attribute is separated by a pipe (|).

Below are the modals and Javascript functions being called when the icons are clicked. Mind you, the Javascript functions below are just for the documentation. THey need to be your own functions that you will call when the action icons are clicked.

        
            <!-- send message modal -->
            <x-bladewind.modal name="send-message" title="">
                <div class="mb-6">
                    The message will be delivered to their company
                    inbox if they are not currently online
                </div>
                <x-bladewind.textarea
                    placeholder="Type message here..." rows="5" />
            </x-bladewind.modal>

            <!-- delete user modal -->
            <x-bladewind.modal
                    name="delete-user"
                    type="error" title="Confirm User Deletion">
                Are you really sure you want to delete <b class="title"></b>?
                This action cannot be reversed.
            </x-bladewind.modal>
        
    

        
        sendMessage = (first_name, last_name) => {
            showModal('send-message');
            domEl('.bw-send-message .modal-title').innerText = `Send Message to ${first_name} ${last_name}`;
        }

        deleteUser = (id, first_name, last_name) => {
            showModal('delete-user');
            domEl('.bw-delete-user .title').innerText = `${first_name} ${last_name}`;
        }

        redirect = (url) => {
            window.open(url);
        }
        
    

No Data Returned

When building dynamic table you will most likely be fetching your data from either an API or a database. You will barely be manually creating arrays as we did above. Now with dynamic data, it is likely your API or query will return no records. You can display a custom translatable message in such a case. You can set the no_data_message to any message you wish to display.

<x-bladewind::table
    no_data_message="The staff directory is empty"
    :data="$staff"  />

The dynamic table builds its column headings from the array keys defined in data. When there are no records to display, the array will be empty, thus, there will be no column headings to deduce. This is why there are no columns displayed with the no data message. If you wish to display column headings with the no data message, you will need to pass column_aliases.

    $column_aliases = [
        'id' => 'ref #',
        'first_name' => 'first name',
        'last_name' => 'last name',
        'marital_status' => 'married?'
    ];

<x-bladewind::table
    has_border="true"
    no_data_message="The staff directory is empty"
    :column_aliases="$column_aliases"
    :data="$staff"  />

Finally, it is possible to display the no data message using the Empty State component. All the attributes of the component are allowed except message and class, since the table component already has its own class attribute, and message here is already no_data_message.

To display the message in an empty state, set the attribute message_as_empty_state="true".

<x-bladewind::table
    :data="$no_staff"
    has_border="true"
    :column_aliases="$column_aliases"
    no_data_message="The staff directory is empty"
    message_as_empty_state="true"
    button_label="add staff member" />

Searchable Table Data

The table component provides a very basic way for users to search through table content. If the searchable="true" attribute is set, a search field is placed above the table that makes it possible to search through any column of the table. The placeholder text for the search input can be replaced by setting the search_placeholder attribute on the table. Non-dynamic tables can also be searchable.

    <x-bladewind::table
        searchable="true"
        :data="$staff"
        divider="thin"
        search_placeholder="Find staff members by name..."
        :action_icons="$action_icons"
        exclude_columns="id, marital_status" />

Aliasing Column Names

There are times your array might contain keys that are not user-friendly enough to be column headings. From our array above assuming we wanted to replace marital_status to married?, we will set the column_aliases attribute. This attributes accepts a json encoded array.

    $column_aliases = [
        'id' => 'ref #',
        'marital_status' => 'married?'
    ];

    <x-bladewind::table
        exclude_columns="id"
        divider="thin"
        :action_icons="$action_icons"
        :column_aliases="$column_aliases"
        :data="$staff" />

Grouping Rows

Let's assume you have a table of employees and wish to group these employees by department, so all staff in Marketing will be under the marketing heading and so on. This can be achieved by specifying the groupby attribute on the table. The value of groupby will need to be any of the keys in your array .

From the employee example above, we will set our grouping on the department key which happens to be to repeated for our employees. groupby="department".

    $staff = [
        [
            'id' => 1,
            'first_name' => 'Michael',
            'last_name' => 'Ocansey',
            'department' => 'Engineering',
            'email' => 'mike@email.com'
        ],
    ]
    ...

    <x-bladewind::table
        exclude_columns="last_name"
        divider="thin"
        groupby="department"
        :data="$staff" />

Sorting

A BladewindUI table that accepts dynamic data can become sortable by setting sortable="true". Automatically, all columns in the table can be clicked on to sort the table. Each sortable column has a filter icon next to the column heading.

    <x-bladewind::table
        exclude_columns="member_id, email"
        sortable="true"
        limit="5"
        :data="$users" />

From the above table you can see every column in the table has a filter icon next to the column heading indicating that the column is sortable. There are cases you will want to sort your table using only very specific columns. This can be achieved by setting the sortable_columns attribute to a comma separated list of columns you want to make sortable.

    <x-bladewind::table
        exclude_columns="member_id, email"
        sortable="true"
        limit="5"
        sortable_columns="first_name, last_name"
        :data="$users" />

Pagination

Pagination is useful for displaying a long list of data in sizable chunks that make it easy to look over the data. The BladewindUI table can be paginated when dealing with dynamic data by setting paginated="true". This will display pagination controls at the end of the table. Multiple tables on the same page can be paginated. The page_size attribute determines how many rows are displayed per page. The default value is 25.

For convenience, paginated tables can display row numbers to make it easy to validate row counts. This is not enabled by default. To turn on row numbers set show_row_numbers="true".

    <x-bladewind::table
        exclude_columns="member_id, email"
        paginated="true"
        page_size="5"
        show_row_numbers="true"
        :data="$users" />

You may not always want to start displaying your table rows from page 1. Maybe, the user bookmarked a record that is on page 6 and you want to jump to that on page load. This can be achieved by setting the default_page attribute. The value of default_page is set to 1 if the value provided is greater than the total_pages.

    <x-bladewind::table
        exclude_columns="member_id, email"
        paginated="true"
        page_size="5"
        show_row_numbers="true"
        default_page="15"
        :data="$users" />

Custom Table Layouts

Pagination is automagically applied to a BladewindUI table that accepts dynamic data. By default the table layout is flat. Every key in the array/data is created as a column. Sometimes you may want to have a custom table layout that merges various columns into one but you still want to enjoy the library's pagination. Still set paginated="true" and :data="$your_data" but, in this case you will be responsible for manually setting up a few things on the data rows. You will also need to include the pagination component manually. You will also need to set layout="custom"

<x-bladewind::table
    layout="custom"
    :paginated="true"
    :page_size="$page_size = 5"
    :data="$users"
    :default_page="$default_page = 6">

    <x-slot:header>
        <th>Member ID</th>
        <th>User Details</th>
        <th>Contact Details</th>
    </x-slot:header>

    <tbody>
    
        @foreach($users as $user)
            @php
                // set avatar url
                $image = ($loop->even) ? 'male.png' : 'female.png';
            @endphp
            <tr {{pagination_row($loop->iteration, $page_size, $default_page)}} >
                <td class="!w-1 !pr-0"><div class="pt-3">{{$user['member_id']}}</div> </td>
                <td>
                    <div class="flex space-x-3">
                        <div><x-bladewind::avatar image="/assets/images/{{$image}}" size="small" /></div>
                        <div>
                            <div class="text-base font-semibold">{{$user['first_name']}} {{$user['last_name']}}</div>
                            <div>{{$user['company_name']}}</div>
                        </div>
                    </div>
                </td>
                <td>
                    <div>{{$user['mobile']}}</div>
                    <div><a href="#">{{$user['email']}}</a></div>
                </td>
            </tr>
        @endforeach
    
    </tbody>
</x-bladewind::table>

Let's breakdown the example above. Pay attention to lines 2, 4, 6 and 22. Let's talk about line 22 first. The pagination widget relies on a couple of attributes defined on the data rows to work properly. A typical data row in a pagination table looks like this:

    <tr data-id="12" data-page="1" class="hidden"> ... </tr>
    ...
    <tr data-id="34" data-page="6"> ... </tr>
    <tr data-id="35" data-page="6"> ... </tr>
    ...
    <tr data-id="272" data-page="9" class="hidden"> ... </tr>

As we loop to generate the table rows, any row that has its data-page attribute not corresponding to the default_page is set to class="hidden". So from our example above, we set default_page="6", any row that is not on page 6 will need to be hidden. Generating these attributes required for pagination can be a headache so a helper function is provided.

Adding pagination_row($row_number, $page_size, $default_page) to each row will generate the attributes required by the pagination widget.
$row_number is the current iteration/$index of the loop. Start with 1 not 0.
$page_size is how many records should be displayed per page.
$default_page is which page to select by default.

Note how on line 4 we defined :page_size="$page_size = 5". This simply makes the variable $page_size available for us to use later when calling pagination_row($row_number, $page_size, $default_page). This is simply to avoid repetition and nothing more. We could have alternatively decided to do what's below.

<x-bladewind::table
    ...
    page_size="5"
    default_page="6">
    ...
    
        @foreach($users as $user)
            <tr {{pagination_row($loop->iteration, 5, 6)}} >
            ...
        @endforeach
    
    </tbody>
</x-bladewind::table>

From the example above, if we later change page_size="20", we will need to also update pagination_row($loop->iteration, 20, 6).

Pagination Styles

There are three pagination styles to choose from. The default style is arrows. The page number is displayed by default for the arrows pagination style. When you set the show_total_pages="true" attribute, the page number is displayed as a fraction (a/b), where 'a' is the current page and 'b' is the total number of pages.

The pagination totals label (Showing 1 to 5 of 222 records) can be hidden by setting show_total="false". This is turned on by default. Content of the label can be changed by setting the total_label attribute. The default is Showing :a to :b of :c records. There are 3 placeholders, :a, :b, and :c. The alphabets used for the placeholders need to be maintained.

:a - the starting row number of the current page.
:b - the ending row number of the current page.
:c - the total records.

total_label=":a - :b of :c" will display: 1 - 5 of 50
total_label="Showing :a - :b" will display: Showing 1 - 5

Arrows

    <x-bladewind::table
        exclude_columns="member_id, email"
        paginated="true"
        page_size="5"
        total_label="Records :a - :b"
        show_row_numbers="true"
        pagination_style="arrows"
        :data="$users"
        show_total_pages="true"/>

Dropdown

Set pagination_style="dropdown" on the table component.

Numbers

Set pagination_style="numbers" on the table component.

    <x-bladewind::table
        exclude_columns="member_id, email"
        paginated="true"
        page_size="5"
        total_label="Records :a - :b"
        show_row_numbers="true"
        pagination_style="numbers"
        :data="$users"
        show_total_pages="true"/>

Full List Of Attributes

The table below shows a comprehensive list of all the attributes available for the Table component.

Table with all attributes defined

        
            <x-bladewind::table
                striped="true"
                divided="true"
                divider="thin"
                has_shadow="true"
                has_border="true"
                compact="true"
                transparent="true"
                searchable="false"
                search_placeholder=""
                name="staff-table"
                :data="$data"
                :column_aliases="$column_aliases"
                include_columns="first_name, last_name, email"
                exclude_columns="id,picture"
                :action_icons="$action_icons"
                action_title=""
                no_data_message="The staff directory is empty"
                message_as_empty_state="true"
                button_label="add staff member"
                image="asset('images/no-data.png')"
                heading="No Staff"
                groupby="department"
                selected_value="2,3,4"
                onclick="alert('add a staff')"
                sortable="false",
                paginated="false",
                pagination_style="arrows",
                page_size="25",
                show_row_numbers="false",
                show_page_number="false",
                show_total="true",
                limit="40"
                layout="custom"
                total_label="Showing :a to :b of :c records",
                has_hover="true">

                <x-slot name="header">
                    ...
                </x-slot>

                <tr>
                ...
                </tr>

            </x-bladewind::table>