package.manifest

8.0.0

Schema URL

https://catalog.lintel.tools/schemas/schemastore/package-manifest/versions/8.0.0.json
← Back to package.manifest
Type: object

Properties

javascript string[]

A list of Javascript files with full path to load for your property editor

uniqueItems=true
css string[]

A list of CSS files with full path to load for your property editor

uniqueItems=true
propertyEditors array

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.

minItems=1
parameterEditors editors[]

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.

minItems=1
gridEditors gridEditor[]

Returns an array of grid editor objects, each object specifies a grid editor to make available in the Grid Layout property editor.

minItems=1
dashboards dashboard[]

V8: Returns an array of dashboards, each object specified a dashboard to make available in the backoffice.

minItems=1uniqueItems=true
sections section[]

V8: Returns an array of sections/applications to add to the Umbraco backoffice.

minItems=1uniqueItems=true
contentApps contentApp[]

V8: Returns an array of Content Apps to add to the Umbraco backoffice.

minItems=1uniqueItems=true

Definitions

editor object

This describes details about the editor

view string

This is the full path to the HTML view for your property editor

hideLabel boolean

If set to true this hides the label for the property editor when used in Umbraco on a document type

valueType string

This is the type of data you want your property editor to save to Umbraco

Values: "STRING" "JSON" "DATETIME" "TEXT" "INT"
validation object

Object describing required validators on the editor

isReadOnly boolean

If set to true this makes the property editor read only

Default: false
editors object
alias string required

This must be a unique alias to your property editor

editor object required

This describes details about the editor

5 nested properties
view string

This is the full path to the HTML view for your property editor

hideLabel boolean

If set to true this hides the label for the property editor when used in Umbraco on a document type

valueType string

This is the type of data you want your property editor to save to Umbraco

Values: "STRING" "JSON" "DATETIME" "TEXT" "INT"
validation object

Object describing required validators on the editor

isReadOnly boolean

If set to true this makes the property editor read only

Default: false
name string required

The friendly name of the property editor, shown in the Umbraco backoffice

defaultConfig object

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.

isParameterEditor boolean

Enables the property editor as a macro parameter editor can be true/false

Default: false
icon string

A CSS class for the icon to be used in the 'Select Editor' dialog eg: icon-autofill

group string

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'

gridEditor object
name string required

The friendly name of the grid editor, shown in the Umbraco backoffice

alias string required

This must be a unique alias to your grid editor

view string required

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 eg.: '~/App_Plugins/FolderName/editor.html'

icon string

A CSS class for the icon to be used in the 'Select Editor' dialog eg: icon-autofill

render string

This is front end razor view for your grid editor. Accepts full path to a custom view eg.: '~/App_Plugins/FolderName/editor.cshtml

config object

Configuration for the grid editor. Can be used with textstring and media views or for custom configuration properties

3 nested properties
style string

If used with the textstring view this accepts inline css to style the textstring box eg.: font-size: 30px; line-height: 40px; font-weight: bold

markup string

If used with the textstring view this allows wrapping the value in custom markup eg.:

#value#

size object

If used with the media view this accepts height and width key/value pairs for cropping

2 nested properties
height integer

Height of image in pixels

width integer

Width of image in pixels

preValues object
prevalues object

This is an object that stores an array of prevalue fields or options to configure your property editor

1 nested properties
fields object[]

This is the collection of prevalue fields

minItems=1
fields object[]

This is the collection of prevalue fields

dashboard object

An Umbraco dashboard to display contextual information when in a section/application

alias string required

The alias of the dashboard which can be queried via Dashboard Service API

minLength=1
view string required

This is the full path to the HTML view for your dashboard

minLength=1
sections string[] required

A list of section/application aliases that the dashboard should be visible in

minItems=1uniqueItems=true
weight integer

The weight (sort order) of the dashboard. Defaults to 100 if not specified.

access object[]

A list of what user groups aliases are granted or denied permission to see the dashboard. This is optional. If not specified all users will have grant access

minItems=1uniqueItems=true
section object

An Umbraco section/application to extend the backoffice

name string required

The friendly name of the section/application, shown in the Umbraco backoffice

minLength=1
alias string required

The alias of the section/application which can be queried via Section Service API

minLength=1
contentApp object

An Umbraco section/application to extend the backoffice

name string required

The friendly name of the content app that appears under the icon

minLength=1
alias string required

A unique alias of the content app

minLength=1
icon string required

A CSS class for the icon to be used for the content app eg: icon-calculator

view string required

This is the full path to the HTML view for your content app

weight integer

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

show string[]

A list of rules to show or hide the content app based on content, media & member types

uniqueItems=true