package.manifest
Umbraco package configuration file
| Type | object |
|---|---|
| File match |
package.manifest
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/package-manifest/latest.json |
| Source | https://www.schemastore.org/package.manifest.json |
Versions
Validate with Lintel
npx @lintel/lintel checkProperties
The (NuGet) package ID, shown in the backoffice and included in package telemetry as unique identifier (supported in v12+). Also used to retrieve the assembly informational version if no explicit version and versionAssemlbyName is set.
The (friendly) package name, shown in the backoffice and included in package telemetry. If not specified, uses the directory name instead.
The package version, shown in the backoffice and included in package telemetry. If not specified, uses the versionAssemblyName or id to retrieve the assembly informational version.
The assembly name to retrieve the informational version, if no explicit version is set. If not specified, uses the id instead (supported in v12+).
Allows you to opt-out of including your package in telemetry reports if set to false, defaults to true.
The full path to an HTML view for your package to help users maintain configuration data when viewing installed packages in the backoffice.
Default: The assets will be bundled with the typical packages bundle. None: The assets in the package will not be processed at all and will all be requested as individual assets in debug and production. Independent: The packages assets will be processed as it's own separate bundle (in debug, files will not be processed).
A list of JavaScript files with full path to load in the backoffice.
A list of CSS files with full path to load in the backoffice.
Returns an array of editor objects, each object specifies an editor to make available to data types as an editor component. These editors are primarily property editors for content, media and members, but can also be made available as a macro parameter editor.
Returns an array of editor objects, each object specifies an editor to make available to macro parameters as an editor component. These editors work solely as parameter editors, and will not show up on the property editors list.
Returns an array of grid editor objects, each object specifies a grid editor to make available in the Grid Layout property editor.
Returns an array of dashboards, each object specified a dashboard to make available in the backoffice.
Returns an array of sections/applications to add to the backoffice.
Returns an array of Content Apps to add to the backoffice.
Definitions
This describes details about the editor.
This is the full path to the HTML view for your property editor.
If set to true, this hides the label for the property editor when used on a document type.
This is the type of data you want your property editor to save to the database.
Object describing required validators on the editor.
If set to true, this makes the property editor read-only.
If set to true, this will disable the default read-only overlay and requires the editor to implement support for this instead.
This must be a unique alias to your property editor.
This describes details about the editor.
6 nested properties
This is the full path to the HTML view for your property editor.
If set to true, this hides the label for the property editor when used on a document type.
This is the type of data you want your property editor to save to the database.
Object describing required validators on the editor.
If set to true, this makes the property editor read-only.
If set to true, this will disable the default read-only overlay and requires the editor to implement support for this instead.
The friendly name of the property editor, shown in the backoffice.
Provides a collection of default configuration values, in cases the property editor is not configured or is used a parameter editor, which doesn't allow configuration. The object is a key/value collection and must match the prevalue fields keys.
Enables the property editor as a macro parameter editor.
A CSS class for the icon to be used in the 'Select Editor' dialog, e.g. icon-autofill.
The group to place this editor in within the 'Select Editor' dialog. Use a new group name or alternatively use an existing one such as Pickers.
The friendly name of the grid editor, shown in the backoffice.
This must be a unique alias to your grid editor.
This is backoffice HTML view for your grid editor. Either refers to one of the built-in view (textstring, rte, embed, macro, media) or the full path to a custom view, e.g. ~/App_Plugins/FolderName/editor.html.
A CSS class for the icon to be used in the 'Select Editor' dialog, e.g. icon-autofill.
This is front end Razor view for your grid editor. Accepts full path to a custom view, e.g. ~/App_Plugins/FolderName/editor.cshtml.
Configuration for the grid editor. Can be used with textstring and media views or for custom configuration properties.
3 nested properties
If used with the textstring view, this accepts inline CSS to style the textstring box, e.g. font-size: 30px; line-height: 40px; font-weight: bold;.
If used with the textstring view, this allows wrapping the value in custom markup, e.g. <h2>#value#</h2>.
If used with the media view, this accepts height and width key/value pairs for cropping.
2 nested properties
Height of image in pixels.
Width of image in pixels.
This is an object that stores an array of prevalue fields or options to configure your property editor.
1 nested properties
This is the collection of prevalue fields.
A dashboard to display contextual information when in a section/application.
The alias of the dashboard which can be queried via the Dashboard Service API.
This is the full path to the HTML view for your dashboard.
A list of section/application aliases that the dashboard should be visible in.
The weight (sort order) of the dashboard. Defaults to 100 if not specified.
A list of what user groups aliases are granted or denied permission to see the dashboard. All users will have access if not specified.
A section/application to extend the backoffice.
The friendly name of the section/application, shown in the backoffice.
The alias of the section/application which can be queried via the Section Service API.
A section/application to extend the backoffice.
The friendly name of the content app that appears under the icon.
A unique alias of the content app.
A CSS class for the icon to be used for the content app, e.g. icon-calculator.
This is the full path to the HTML view for your content app.
The weight (sort order) of the content app. Default is 0, use values between -99 and +99 to appear between the existing Content (-100) and Info (100) apps.
A list of rules to show or hide the content app based on content, media and member types.