Browse Source

Add Suite React UI context notes

Co-authored-by: Cursor <cursoragent@cursor.com>
pull/25422/head
Engincan VESKE 4 months ago
parent
commit
ce07786864
  1. 2
      docs/en/suite/create-solution.md
  2. 2
      docs/en/suite/creating-many-to-many-relationship.md
  3. 2
      docs/en/suite/creating-master-detail-relationship.md
  4. 2
      docs/en/suite/customizing-the-generated-code.md
  5. 2
      docs/en/suite/editing-templates.md
  6. 2
      docs/en/suite/generating-crud-page.md

2
docs/en/suite/create-solution.md

@ -25,4 +25,6 @@
From ABP Suite v8.3, **create a new solution** option has been removed. Instead, it's suggessted to use [ABP Studio](../studio/index.md) or [ABP CLI](../cli/index.md) to create a new solution. After, creating an ABP Solution, then you can generate CRUD pages via ABP Suite as always.
> **Note:** ABP Suite does not generate React UI pages. If you create a modern React solution, use Suite where applicable for backend and application-layer generation, and develop the React UI in the source-owned [React UI](../framework/ui/react/index.md) application.
> ABP Studio has a shortcut for running [ABP Suite](./index.md) to allow using it without starting it externally and using it on a browser, which means you can create, manage, deploy your applications in a single desktop application and also generate CRUD pages via Suite as a pre-integrated application to ABP Studio.

2
docs/en/suite/creating-many-to-many-relationship.md

@ -75,4 +75,6 @@ Click the **Navigations** tab. Then click the **Add navigation collection** butt
The below image is the final page created by ABP Suite. The **new book** dialog has a **Categories** tab which lists all categories of the book and allows add/remove categories.
> **Note:** ABP Suite does not generate React UI for this page. The generated UI applies to Suite-supported UI stacks such as MVC, Blazor and Angular.
![navigation-collection-books-page](../images/navigation-collection-books-page.8.1.png)

2
docs/en/suite/creating-master-detail-relationship.md

@ -39,6 +39,8 @@ You need to specify the **Entity type** as _Master_ (default). Then, provide the
Create a child entity, specify the **Entity type** as _Child_, and associate it with a master entity. In the figure above, you can see an example of, a child entity **OrderLine** with the associated master entity **Order**. When you specify the **Entity type** as _Child_, then the UI and tests will not be generated for the child entity and instead, all of the orchestration of the entity will be delegated to its master entity.
> **Note:** ABP Suite does not generate React UI for master-detail pages. The generated UI applies to Suite-supported UI stacks such as MVC, Blazor and Angular.
Application services will be generated for the child entity, so it's possible for you to consume its endpoints and create-update-list or delete the child entity specifically. Suite also respects your multi-tenancy selection and sets the child entity as a multi-tenant entity, if the master entity has multi-tenancy enabled.
> **Note**: Child entities are not a good candidate to establish a many-to-many relationship and therefore that's disabled in the Suite UI. So, you can't create a many-to-many relationship for child entities, but you can create a one-to-many relationship.

2
docs/en/suite/customizing-the-generated-code.md

@ -58,6 +58,8 @@ You can see the example below, which demonstrates defining a new method in the `
For the UI side, ABP Suite provides convenient comment placeholders within pages for MVC, Blazor, and Angular UIs. These comment sections serve as hook points where you can add your custom code. By placing your custom logic with these hook points, you can enhance the UI to your needs without the fear of losing your changes during the next CRUD page generation.
> **Note:** ABP Suite does not generate React UI pages or React customization hook points. React UI is part of ABP's modern template system and is customized directly in the source-owned [React UI](../framework/ui/react/index.md) application.
### Customizations on MVC UI
If you have created your application with MVC UI, you can see the extended classes for _the code-behind classes of your pages_, under the `Pages` folder:

2
docs/en/suite/editing-templates.md

@ -16,6 +16,8 @@ The are 2 template filters:
1. **UI**: You can switch between `Angular`, `MVC` and `Blazor` templates.
2. **Database provider:** You can switch between `EF Core` and `MongoDb` templates.
> **Note:** ABP Suite does not include React UI templates or generate React client-side code. React UI belongs to the modern template system and should be developed in the source-owned [React UI](../framework/ui/react/index.md) application.
These filters are automatically selected based on your ABP solution. The selected solution is shown on the top right of the page. In the current screenshot it is "Acme.BookStore".
ABP Suite templates are embedded resources which are stored in the `Volo.Abp.Commercial.SuiteTemplates` package. When you update your project, Suite templates are also being updated. To be able to generate the correct code for your project, the version of `Volo.Abp.Commercial.SuiteTemplates` must be the same as your Suite version.

2
docs/en/suite/generating-crud-page.md

@ -110,6 +110,8 @@ To create a new entity, make sure the *-New entity-* is selected in the **Entity
* **Create user interface:** Creates pages, modals, components, `JavaScript`, `CSS ` files and adds the new page to the main menu. If you don't have a requirement to manage the entity via user interface, you can uncheck this option.
> **Note:** This option does not generate React UI pages. ABP Suite's UI generation targets Suite-supported UI stacks such as MVC, Blazor and Angular. For React-based solutions, build the UI in the source-owned [React UI](../framework/ui/react/index.md) application.
* **Excel export**: Creates a button that exports a list of all the data that were added to the entity to an Excel file.
* **Bulk delete**: Performs bulk deletion of records based on specified criteria.

Loading…
Cancel
Save