You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guide/index.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,15 +29,15 @@ For **products**, we decide that we don't need to build a `Show Page`:
29
29
30
30
The product `Entity List` may have filters, sorting columns and search, and an `Entity state` to manage the published state of each product.
31
31
32
-
Finally, **orders**, must be listed, detailed and updatable, and we also need to manage the **product** list of each order. That's an `Entity List` linking to a `Show Page` which contains another `Entity List`:
32
+
Finally, **orders** must be listed, detailed and updated, and we also need to manage the **product** list for each order. That's an `Entity List` linking to a `Show Page` which contains another `Entity List`:
Maybe we can add an `Entity Command` to export orders in a CSV file in the `Entity List`, and an `Instance command` on the order `Show Page` to declare the order as shipped.
39
39
40
-
This is a simple example to illustrate the main concepts of Sharp: we'll see in this guide how to build such structures but also more complexe ones, and how to manage states, commands, dashboards, authorizations, errors, validation... in the process.
40
+
This is a simple example to illustrate the main concepts of Sharp: we'll see in this guide how to build such structures but also more complex ones, and how to manage states, commands, dashboards, authorizations, errors, validation... in the process.
- Add the package with composer: `composer require code16/sharp`
47
47
- Then run: `php artisan sharp:install`
48
48
49
-
This last script will publish required assets, create a `SharpServiceProvider` in the `App\Providers` namespace, and a `SharpMenu` class in the `App\Sharp` namespace.
49
+
This last script will publish required assets, create a `SharpServiceProvider` in the `App\Providers` namespace and a `SharpMenu` class in the `App\Sharp` namespace.
50
50
51
51
## Configuration via a new Service Provider
52
52
@@ -71,7 +71,7 @@ class SharpServiceProvider extends SharpAppServiceProvider
71
71
```
72
72
73
73
::: tip
74
-
As shown in the [Entity class](entity-class.md) documentation, you can also let Sharp autodiscover your entities.
74
+
As shown in the [Entity class](entity-class.md) documentation, you can also let Sharp auto-discover your entities.
75
75
:::
76
76
77
77
This `ProductEntity` class could be written like this:
@@ -91,10 +91,10 @@ We chose to define:
91
91
92
92
- a `list` class, responsible for the `Entity List`,
93
93
- a `show` class, responsible for displaying an `instance` in a `Show Page`,
94
-
- a `form` class, responsible for the create and edit `Form`,
94
+
- a `form` class, responsible for the creation and edit `Form`,
95
95
- and a `policy` class, for authorizations.
96
96
97
-
Almost each one is optional, in fact: we could skip the `show` and go straight to the `form` from the `list`, for instance.
97
+
Almost each one is optional: we could skip the `show` and go straight to the `form` from the `list`, for instance.
98
98
99
99
We'll get into all those classes in this guide. The important thing to notice is that Sharp provides base classes to handle all the wiring (and more), but as we'll see, the applicative code is totally up to you.
Copy file name to clipboardExpand all lines: docs/index.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,13 +28,13 @@ Sharp for Laravel is actively maintained and developed and is used in all kinds
28
28
## Streamlined Lists
29
29
30
30
### Customizable columns
31
-
Choose and format the data to display, and allow sorting.
31
+
Choose and format the data to display and allow sorting.
32
32
33
33
### Search and filters
34
34
Define filters for your lists, with various types and options.
35
35
36
36
### State management
37
-
If your entities have some state, you can manage it easily form here.
37
+
If your entities have some state, you can manage it easily from here.
38
38
39
39
<figure>
40
40
@@ -56,7 +56,7 @@ Create commands to act on a single instance or on a selection (filtered list or
56
56
Easily attach forms to commands, with validation and confirmation.
57
57
58
58
### Wizards
59
-
Create multi-steps commands with dynamic paths.
59
+
Create multistep commands with dynamic paths.
60
60
61
61
<figure>
62
62
@@ -72,10 +72,10 @@ Create multi-steps commands with dynamic paths.
72
72
## Comprehensive Forms
73
73
74
74
### Fields and layout
75
-
Use one of the many fields available, and organize them in a layout that fits your needs.
75
+
Use one of the many fields available and organize them in a layout that fits your needs.
76
76
77
77
### Powerful editor with embeds
78
-
Sharp's custom editor really allows to create rich content, and includes a clever system to develop custom embeds.
78
+
Sharp's custom editor really allows creating rich content and includes a clever system to develop custom embeds.
79
79
80
80
### Uploads
81
81
Manage files with bulk uploads, image transformation, disk and path configuration and precise validation.
@@ -193,9 +193,9 @@ With a clean and documented API.
193
193
194
194
# About Sharp
195
195
196
-
Sharp is a longterm project developed by [Code 16](https://code16.fr), a web agency based in France, since 2017. We use it in almost all our projects, and we are committed to maintaining and improving it over time.
196
+
Sharp is a long-term project developed by [Code 16](https://code16.fr), a web agency based in France, since 2017. We use it in almost all our projects, and we are committed to maintaining and improving it over time.
197
197
198
-
Sharp 9 relies on Laravel 11, Tailwind CSS, Inertia, Vue and Alpine.JS.
198
+
Sharp 9 relies on Laravel, Tailwind CSS, Inertia, Vue and Alpine.JS.
199
199
200
200
So far we have not implemented any kind of sponsorship system, but we are open to discussing it in the future.
0 commit comments