Create a PowerGrid Table

This section covers the the process of creating a PowerGrid Component.

Here you will find:

• Introduction
• Create a Table
• Customize the Component Creation

Introduction

Now that you've finished the PowerGrid Essential Configuration, it's time create your very first Table Component!

Create a Table

To create a PowerGrid Table, run the following command in your Laravel project.

php artisan powergrid:create

The assistant will guide you through the process and help you generate your Table Component.

1. Name the Component

First, you need to name your new Table Component.

In this example, let's create a component called "DishTable" to list all dishes in a food menu.

     __     ____                          ______     _     __
    / /_,  / __ \____ _      _____  _____/ ____/____(_)___/ /
    /_ ,' / /_/ / __ \ | /| / / _ \/ ___/ / __/ ___/ / __  / 
    /'   / ____/ /_/ / |/ |/ /  __/ /  / /_/ / /  / / /_/ /  
        /_/    \____/|__/|__/\___/_/   \____/_/  /_/\__,_/     

 ┌ What is the name of your Table Component? ───────────────────┐
 │ DishTable                                                    │
 └──────────────────────────────────────────────────────────────┘

To create your Component in a subdirectory, just enter the directory path followed by the component name. For example: Tables/Dishes/DishTable.

If your application is organized in a different architecture (E.g, Domain-Driven Design), proceed to read more on how to configure a Custom Namespace for PowerGrid Components.

---

2. Select the Data Source

Now, configure the data source from which your Table will pull data from.

2.1. Select the data source

Select the data source type.

In our example, we will use Laravel's Eloquent Builder.

 ┌ What type of data source will you use? ──────────────────────┐
 │ › ● Eloquent Builder                                         │
 │   ○ Query Builder                                            │
 │   ○ Collection                                               │
 └──────────────────────────────────────────────────────────────┘

2.2. Model

Here, you need to select a Model to be linked to the component.

Following our example, we will use the Dish Model.

 ┌ Select a Model or enter its Fully qualified name. ───────────┐
 ├──────────────────────────────────────────────────────────────┤
 │› App\Models\Dish                                             │
 │  App\Models\FooBar                                           │
 │  App\Models\FoorBarBaz                                       │
 └──────────────────────────────────────────────────────────────┘

By default, PowerGrid suggests Eloquent Models placed in the default path app/Models.

You can customize the Auto-Discover Models if your application is organized in a different architecture (E.g, Domain-Driven Design).

2.3. Fillable

If desired, PowerGrid has the capability to automatically generate certain Table Columns based on the fields specified in your Model's fillable property.

Sure, let's proceed with "yes" for this example.

 ┌ Create columns based on Model's fillable property? ──────────┐
 │ ● Yes / ○ No                                                 │
 └──────────────────────────────────────────────────────────────┘

Note: This feature is available only for MySQL, PostgreSQL, and SQLite databases.

3. Use Your Table

⚡ Your PowerGrid Table is ready!

At this step, you should see a message that looks like this:

⚡ DishTable was successfully created at [app/Livewire/DishTable.php].

💡 include the DishTable component using the tag: <livewire:dish-table/>

In the feedback message, you will find:

• The file path where your Component was created.
• The HTML tag to include it in your Blade View.

🎉 That's it!

Now we can proceed to the Show a PowerGrid Table section.

Customize the Component Creation

Component Stubs

You may customize the default PowerGrid Component, adapting it to your needs.

To publish the stub, run the following command:

php artisan powergrid:publish --type=stub

If you need to create multiple stubs, be sure to rename the file after publishing each stub.

You may use the flag --template passing the full location of your stub when creating a new component.

php artisan powergrid:create --template=stubs/custom-component.stub

Custom Namespace

See Custom Namespace.

Custom Model Location

See Auto-Discover Models.