-
Notifications
You must be signed in to change notification settings - Fork 811
"Extension Types" documentation updates #7302
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 9 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
2bea55a
Expand "Extension Types" documentation and correct minor code formatt…
bszyman d2eb98b
Incorporating suggestions from Andy Butland. Added tip-tap extensions…
bszyman f838b10
Incorporating suggestions from Andy Butland. Added tip-tap extensions…
bszyman 2521056
Merge branch 'main' into extension-types-pr
bszyman 18ae41d
Merge remote-tracking branch 'origin/extension-types-pr' into extensi…
bszyman 233af9f
Linting
bszyman 66ec5c7
Refine "Extension Types" documentation: fixed formatting inconsistenc…
bszyman c91e022
Renaming "Sections" to "Section" to fix linter
bszyman 619fe13
Reordered and grouped extension type sections for clarity and consist…
61a1357
Update 16/umbraco-cms/customizing/extending-overview/extension-types/…
eshanrnh 18c7fe1
Update 16/umbraco-cms/customizing/extending-overview/extension-types/…
eshanrnh fba0d9b
Update 16/umbraco-cms/customizing/extending-overview/extension-types/…
eshanrnh 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
114 changes: 100 additions & 14 deletions
114
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
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,31 +1,117 @@ | ||
| --- | ||
| description: >- | ||
| The Extension types have some general features and some are provide | ||
| specifically to a type. | ||
| An overview of general extension types available in the Umbraco backoffice. | ||
| --- | ||
|
|
||
| # Extension Types | ||
|
|
||
| ### General features <a href="#package-manifest" id="package-manifest"></a> | ||
| ## General Features | ||
|
|
||
| The general features of all Extension Types can be read as part of the [Extension Manifest Article](../extension-registry/extension-manifest.md) | ||
| Extension Types in Umbraco allow developers to extend and customize the behavior of the backoffice. Each type provides unique functionality, such as creating custom dashboards, enhancing entity actions, or enabling localization. Learn more about the shared properties and overall structure in the [Extension Manifest](../extension-registry/extension-manifest.md) article. | ||
|
|
||
| ### General Extension Type <a href="#package-manifest" id="package-manifest"></a> | ||
| ## Common Extension Types | ||
|
|
||
| The system provides Extension Types for certain needs and then there is a few that has a general purpose. | ||
| The **Umbraco backoffice** provides **Extension Types** designed to meet a variety of customization needs. These include extensions tailored for specific functionalities, as well as general-purpose extensions for broader use cases. | ||
|
|
||
| ### [Bundle](bundle.md) <a href="#package-manifest" id="package-manifest"></a> | ||
| ### [App Entry Point](app-entry-point.md) | ||
|
|
||
| The `bundle` type enables you to gather many extension manifests into one. These will be registered at startup. | ||
| The `App Entry Point` extension type is used to execute JavaScript when Umbraco starts up. The code will run before the user has logged in or the backoffice has initialized. | ||
|
|
||
| ### [Backoffice Entry Point](backoffice-entry-point.md) <a href="#entry-point" id="entry-point"></a> | ||
| ### [Backoffice Entry Point](backoffice-entry-point.md) | ||
|
|
||
| The `backofficeEntryPoint` type is used to execute the method of a JavaScript file when the backoffice is initialized. This file can be used to do anything, this enables more complex logic to take place on startup. | ||
| The `backofficeEntryPoint` extension type is used to execute JavaScript upon initialization of the backoffice. This extension type provides lifecycle hooks (startup, teardown) for extension developers to customize backoffice behavior. | ||
|
|
||
| ### [Extension Conditions](condition.md) <a href="#conditions" id="conditions"></a> | ||
| ### [Block Custom View](block-custom-view.md) | ||
|
|
||
| Most Extension Types support conditions. Defining conditions enables you to control when and where the Extension is available. This Type enables you to bring your own Conditions for the system. | ||
| The `blockEditorCustomView` extension type is used to define a custom web component for representing blocks inside the Umbraco block grid property editor. | ||
|
|
||
| ### [Kinds](kind.md) <a href="#kinds" id="kinds"></a> | ||
| ### [Bundle](bundle.md) | ||
|
|
||
| The Kind-type enables you to base your Extension registration on a preset manifest. A kind provides the base manifest that your manifest will be amending. A typical Kind declaration would provide a default Element, making it possible for you to only configure the Element via properties of the Manifest. | ||
| The `bundle` extension type is used to aggregate multiple extension manifests into a single entity, which will be registered at startup. | ||
|
|
||
| ### [Dashboards](dashboard.md) | ||
|
|
||
| The `dashboard` extension type enables extension authors to create custom informational panels that can be displayed in the Umbraco backoffice. These extensions can be added to existing Umbraco sections or to a custom section. | ||
|
|
||
| ### [Entity Actions](entity-actions.md) | ||
|
|
||
| The `entityAction` extension type is used to create menus for operations on an entity such as a document or media item. Built-in backoffice examples include: "Trash", "Duplicate to...", "Publish" etc. | ||
|
|
||
| ### [Entity Bulk Actions](entity-bulk-actions.md) | ||
|
|
||
| The `entityBulkAction` extension type works similarly to the **Entity Actions** extension type, but performs the actions on a selection of entities from a collection. | ||
|
|
||
| ### [Entity Create Option Action](entity-create-option-action.md) | ||
|
|
||
| The `entityCreateOptionAction` extension type is used to provide custom entity creation actions via a dedicated modal interface. | ||
|
|
||
| ### [Extension Conditions](condition.md) | ||
|
|
||
| Most extension types support conditions which allow extension authors to control when and where the extension is available. This type enables extension authors to define their own conditions. | ||
|
|
||
| ### [Global Context](global-context.md) | ||
|
|
||
| The `globalContext` extension type creates a custom context of data and functions, accessible throughout the entire backoffice and the entirety of the session. | ||
|
|
||
| ### [Header Apps](header-apps.md) | ||
|
|
||
| The `headerApp` extension type is used to place single-purpose extensions in the top-level navigation bar. These extensions appear next to the user profile. | ||
|
|
||
| ### [Icons](icons.md) | ||
|
|
||
| The `icons` extension type is used to make custom icon extension sets available in the Umbraco backoffice and in custom Umbraco UI components. Extension authors provide SVG files and register them using this extension type. | ||
|
|
||
| ### [Kinds](kind.md) | ||
|
|
||
| The `kind` extension type is used to create custom extension configurations to be used as the basis of other custom extension types. They can be inherited by other extension types. | ||
|
|
||
| ### [Localization](localization.md) | ||
|
|
||
| The `localization` extension type is used to register additional languages and files of translation strings that can be used in Umbraco backoffice extensions. | ||
|
|
||
| ### [Menu](menu.md) | ||
|
|
||
| The `menu` extension type is used to create custom menus. These can be placed in sidebar extensions or displayed as a fly-out from a button, header, or workspace view. | ||
|
|
||
| ### [Modals](modals/README.md) | ||
|
|
||
| The `modal` extension type is used to configure and present dialogs and sidebars within the Umbraco backoffice. | ||
|
|
||
| ### [Property Value Preset](property-value-preset.md) | ||
|
|
||
| The `propertyValuePreset` extension type is used to customize the default value of a property editor and allow for dynamic behavior through hooks. | ||
|
|
||
| ### [Sections](sections/README.md) | ||
|
|
||
| The `section` extension type is used to place top-level navigation items within the Umbraco backoffice. Custom Section extensions appear alongside Content, Media, Settings, and others, as seen in the purple navigation bar. | ||
|
|
||
| ### [Trees](tree.md) | ||
|
|
||
| The `tree` extension type is used to create a hierarchical structure composed of nodes, such as documents or media extensions or toolbar extensions. | ||
| items. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### [Workspaces](workspaces/README.md) | ||
|
|
||
| The `workspace` extension type provides functionality that operates within specific workspace environments, such as document editing, media management, or member editing. | ||
|
|
||
| ## Even More Extension Types | ||
|
|
||
| ### [Property Level UI Permissions](../../property-level-ui-permissions.md) | ||
|
|
||
| Umbraco allows system administrators to define read and write permissions on an individual property basis. `Property Level UI Permissions` can be created to define customized rules to fit any use case. | ||
|
|
||
| ### [Tip-Tap Extensions](../../../fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/rich-text-editor/extensions.md) | ||
|
|
||
| The Tip-Tap editor is the default text editor in Umbraco. Tip-Tap can be extended with either native extensions or toolbar button extensions. | ||
|
|
||
| ### [Umbraco Flavored Markup Components](../../../reference/umbraco-flavored-markdown.md) | ||
|
|
||
| `Umbraco Flavored Markup (UFM) Components`, are used to create descriptions and labels for entities across the backoffice. These replace the previous "Label Property Configuration" feature. Extension authors can create custom components that go beyond textual labels, including creating hooks that allow for imperative programming tasks and custom markup. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Extension Insights Browser | ||
|
|
||
| Umbraco provides a number of additional extension types that can be used to extend the backoffice. The backoffice contains an interactive browser for exploring all available extension types. This feature also allows users to confirm that their own backoffice extensions are found and loaded by the backoffice. | ||
|
|
||
| To use the Extension Insights browser, navigate to the **Settings** section of the backoffice and select **Extension Insights** from the sidebar. A comprehensive list of available types can be found in the dropdown menu to the right. | ||
|
|
||
| <figure><img src="../../../.gitbook/assets/extension-types-backoffice-browser.png" alt=""><figcaption><p>Backoffice extension browser</p></figcaption></figure> | ||
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.