mirror of
https://github.com/filamentphp/filament.git
synced 2026-09-01 15:09:33 +08:00
docs
This commit is contained in:
@@ -55,10 +55,10 @@ To decrease the [border radius in Tailwind CSS](https://tailwindcss.com/docs/bor
|
||||
|
||||
This overrides the default `rounded-lg` class with `rounded-sm` for all buttons in Filament while preserving the other styling properties of the button. This system provides a high level of flexibility to customize the appearance of Filament components without needing to write a complete custom stylesheet or maintain copies of HTML for each component.
|
||||
|
||||
For more information about customizing the appearance of Filament, visit the [Customizing Styling](../styling) section.
|
||||
For more information about customizing the appearance of Filament, visit the [Customizing styling documentation](../styling).
|
||||
|
||||
## Testing
|
||||
|
||||
The core packages in Filament undergo unit testing to ensure stability across releases. As a Filament user, you can write tests for applications built with the framework. Filament provides utilities for testing both functionality and UI components, compatible with either Pest or PHPUnit test suites. Testing is particularly crucial when customizing the framework or implementing custom functionality, though it's also valuable for verifying basic functionality works as intended.
|
||||
|
||||
For more information about testing Filament applications, visit the [Testing](../testing) section.
|
||||
For more information about testing Filament applications, visit the [Testing documentation](../testing).
|
||||
|
||||
@@ -55,7 +55,7 @@ You can create a new user account using the following command:
|
||||
php artisan make:filament-user
|
||||
```
|
||||
|
||||
Open `/admin` in your web browser, sign in, and start building your app!
|
||||
Open `/admin` in your web browser, sign in, and [start building your app](../getting-started)!
|
||||
|
||||
</div>
|
||||
|
||||
@@ -82,7 +82,7 @@ composer require
|
||||
|
||||
You can install additional packages later in your project without having to repeat these installation steps.
|
||||
|
||||
If you only want to use the set of [Blade UI components](../blade-components), you'll need to require `filament/support` at this stage.
|
||||
If you only want to use the set of [Blade UI components](../components/blade), you'll need to require `filament/support` at this stage.
|
||||
|
||||
<RadioGroup model="laravelProject">
|
||||
<RadioGroupOption value="new">
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: Getting started
|
||||
---
|
||||
|
||||
Once you have [installed Filament](introduction/installation#installing-the-panel-builder), you can start building your application.
|
||||
|
||||
> This guide is for the Filament panel builder. If you are looking to use the Filament UI components outside of a panel, visit the [Components](components) documentation.
|
||||
|
||||
To start with, visit `/admin` and sign in with a user account. You will be redirected to the default dashboard of the panel.
|
||||
|
||||
## Resources
|
||||
|
||||
Resources are the core of your Filament application. They are CRUD UIs for models that you want to manage in the panel.
|
||||
|
||||
Out of the box, Filament will generate 3 pages in each resource:
|
||||
- **List**: A paginated table of all the records in the Eloquent model.
|
||||
- **Create**: A form to create a new record.
|
||||
- **Edit**: A form to edit an existing record.
|
||||
|
||||
You can choose to also generate a **View** page, which is a read-only display of a record.
|
||||
|
||||
Each resource usually has an item in the sidebar, which is automatically registered as soon as you create a resource.
|
||||
|
||||
To start your journey by creating a resource, visit the [Resources documentation](resources).
|
||||
|
||||
## Widgets
|
||||
|
||||
Widgets are components often used to build a dashboard, often to display statistical data. Charts, numbers, tables, and completely custom widgets are supported.
|
||||
|
||||
Each widget has a PHP class and a Blade view. The PHP class is technically a [Livewire component](https://livewire.laravel.com/docs/components). As such, every widget has access to the full power of Livewire to build an interactive server-rendered UI.
|
||||
|
||||
Out of the box, Filament's dashboard contains a couple of widgets: one which greets the user and allows them to sign out, and another which displays information about Filament.
|
||||
|
||||
To start your journey by adding your own widget to the dashboard, visit the [Widgets documentation](widgets).
|
||||
|
||||
## Custom pages
|
||||
|
||||
Custom pages are a blank canvas for you to build whatever you want in a panel. They are often used for settings pages, documentation, or anything else you can think of.
|
||||
|
||||
Each custom page has a PHP class and a Blade view. The PHP class is technically a [full-page Livewire component](https://livewire.laravel.com/docs/components) (in fact, every page class in a Filament panel is a Livewire component). As such, every page has access to the full power of Livewire to build an interactive server-rendered UI.
|
||||
|
||||
To start your journey by creating a custom page, visit the [Custom pages documentation](advanced/custom-pages).
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: Custom pages
|
||||
---
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
title: Introduction to Filament
|
||||
---
|
||||
|
||||
Filament is a meta-framework for Laravel. It aims to provide a set of components and conventions that make it easier to build the frontend for your Laravel applications using Livewire, Alpine.js, and Tailwind CSS. Filament is designed to be flexible and extensible, so you can use as much or as little of it as you like and customize it to fit your needs.
|
||||
|
||||
Thousands of developers choose Filament to add an admin panel interface to their app. You'll be able to do this regardless of what your app's frontend is built using: it's commonly paired with tools like Inertia.js that interface Laravel with a full-fat frontend framework like Vue.js, React, or Svelte.
|
||||
|
||||
If you're building your app's frontend with Blade (Livewire or not), you'll be able to enrich your views with components from the framework to save yourself time. For example, the same form builder and table builder that powers our admin panel tool can be installed into a Livewire component. Livewire components can be inserted into any Blade view or rendered from a route, regardless of whether you're already using Livewire for your other Blade views or not.
|
||||
|
||||
The core package for building admin panels is `filament/filament`, which requires all the other packages in the Filament ecosystem. If you're building a Blade application from scratch, you might want to install the `filament/forms` and `filament/tables` packages to get access to the form and table builders.
|
||||
|
||||
Aside from building admin areas, Filament panels can be used to build a variety of interfaces in your app. For example, you could build a user dashboard in a SaaS app, or a CRM for a certain department in your organization. A single Laravel app can contain multiple panels, each with its own configuration for branding, navigation, and routing. To learn more about panels, see the [Panels Overview](../panels/overview) page.
|
||||
|
||||
Depending on where you are in the development process of your app, you should choose a quickstart guide that fits your immediate need. If you're just interested in learning about Filament, you should probably pick the "Building an admin panel" tutorial, since it covers concepts within multiple packages.
|
||||
|
||||
- [Building an admin panel](building-an-admin-panel)
|
||||
- [Building a SaaS](building-a-saas)
|
||||
- [Adding a form to a Blade view](adding-a-form-to-a-blade-view)
|
||||
- [Adding a table to a Blade view](adding-a-table-to-a-blade-view)
|
||||
- [Adding modals to a Blade view](adding-modals-to-a-blade-view)
|
||||
- [Adding a read-only infolist to a Blade view](adding-a-read-only-infolist-to-a-blade-view)
|
||||
- [Adding a chart to a Blade view](adding-a-chart-to-a-blade-view)
|
||||
- [Sending flash notifications in Livewire](sending-flash-notifications-in-livewire)
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Building an admin panel
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Building a SaaS
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Adding a form to a Blade view
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Adding a table to a Blade view
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Adding modals to a Blade view
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Adding a read-only infolist to a Blade view
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Adding a chart to a Blade view
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Sending flash notifications in Livewire
|
||||
---
|
||||
Reference in New Issue
Block a user