-
Notifications
You must be signed in to change notification settings - Fork 813
Updated UI Builder articles #6990
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,32 @@ | ||
| --- | ||
| description: Conventions used by Umbraco UI Builder, the backoffice UI builder for Umbraco. | ||
| description: Guidelines for fluent configuration and naming conventions in Umbraco UI Builder. | ||
| --- | ||
|
|
||
| # Conventions | ||
|
|
||
| ## Fluent Conventions | ||
|
|
||
| Most configuration methods in Umbraco UI Builder aim to be fluent. This means that they return a relevant config instance allowing to chain multiple methods calls together in one. For those who prefer to be a bit more verbose, many methods also accept an optional lambda expression. This allows you to pass in a delegate to perform the inner configuration of the element being defined. | ||
| Umbraco UI Builder follows a fluent configuration style, allowing method chaining for concise and readable code. Alternatively, a lambda expression can be used for a more structured approach. | ||
|
|
||
| ### Chaining Example | ||
|
|
||
| ```csharp | ||
| config.AddSection("Repositories") | ||
| .Tree() | ||
| .AddCollection<People>(p => p.Id, "Person", "People"); | ||
| ``` | ||
|
|
||
| ### Lambda Expression Example Example | ||
|
|
||
| ```csharp | ||
| // Chaining example | ||
| config.AddSection("Repositories").Tree().AddCollection<People>(p => p.Id, "Person", "People"); | ||
|
|
||
| // Delegate example | ||
| config.AddSection("Repositories", sectionConfig => { | ||
| sectionConfig.Tree(treeConfig => { | ||
| treeConfig.AddCollection<People>(p => p.Id, "Person", "People"); | ||
| }); | ||
| config.AddSection("Repositories", sectionConfig => { | ||
| sectionConfig.Tree(treeConfig => { | ||
| treeConfig.AddCollection<People>(p => p.Id, "Person", "People"); | ||
| }); | ||
| }); | ||
| ``` | ||
|
|
||
| ## Naming Conventions | ||
|
|
||
| Throughout the API, where a method name starts with **Add** then multiple configurations can be declared. Whereas if a method name starts with **Set** then only one instance of the configuration can be declared within the current configuration context. | ||
| * Methods prefixed with **Add** allow multiple configurations. | ||
| * Methods prefixed with **Set** permit only one instance within the current configuration context. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.