Umbraco CMS
CloudHeartcoreDXPMarketplace
13.latest (LTS)
13.latest (LTS)
  • Umbraco CMS Documentation
  • Legacy Documentation
    • Umbraco 11 Documentation
    • Umbraco 8 Documentation
    • Umbraco 7 Documentation
  • Release Notes
  • Contribute
  • Sustainability Best Practices
  • Fundamentals
    • Get to know Umbraco
    • Setup
      • Requirements
      • Installation
        • Install using .NET CLI
        • Install using Visual Studio
        • Local IIS With Umbraco
        • Install using Visual Studio Code
        • Installing Nightly Builds
        • Running Umbraco on Linux/macOS
        • Unattended Installs
      • Upgrade your project
        • Version Specific Upgrades
          • Upgrade from Umbraco 8 to the latest version
          • Migrate content to Umbraco 8
          • Minor upgrades for Umbraco 8
          • Upgrade to Umbraco 7
          • Minor upgrades for Umbraco 7
      • Server setup
        • Running Umbraco On Azure Web Apps
        • Hosting Umbraco in IIS
        • File And Folder Permissions
        • Runtime Modes
        • Umbraco in Load Balanced Environments
          • Load Balancing Azure Web Apps
          • Standalone File System
          • Advanced Techniques With Flexible Load Balancing
          • Logging With Load Balancing
    • Backoffice
      • Sections
      • Property Editors
        • Built-in Property Editors
          • Checkbox List
          • Color Picker
          • Content Picker
          • DateTime
          • Date
          • Decimal
          • Email Address
          • Eye Dropper Color Picker
          • File Upload
          • Image Cropper
          • Label
          • List View
          • Markdown Editor
          • Media Picker
          • Media Picker (Legacy)
          • Member Group Picker
          • Member Picker
          • Multi Url Picker
          • Multinode Treepicker
          • Repeatable Textstrings
          • Numeric
          • Radiobutton List
          • Slider
          • Tags
          • Textarea
          • Textbox
          • Toggle
          • User Picker
          • Block Editors
            • Block Grid
            • Block List
            • Build a Custom View for a Block
            • Configuring Block Editor Label Properties
          • Dropdown
          • Grid Layout (Legacy)
            • What Are Grid Layouts?
            • Configuring The Grid Layout
            • Settings And Styling
            • Grid Editors
            • Build Your Own Editor
            • Rendering Grid In a Template
            • Grid Layout Best Practices
            • Add Values Programmatically
          • Rich Text Editor
            • Rich Text Editor Configuration
            • Rich Text Editor Styles
            • Rich Text Editor Plugins
            • Blocks in Rich Text Editor
      • Login
      • Content Templates
      • Infinite Editing
      • Log Viewer
      • Language Variants
      • Settings Dashboards
    • Data
      • Defining Content
        • Default Document Types
        • Document Type Localization
      • Creating Media
        • Default Data/Media Types
      • Members
      • Data Types
        • Default Data Types
      • Scheduled Publishing
      • Using Tabs
      • Users
      • Relations
      • Dictionary Items
      • Content Version Cleanup
    • Design
      • Templates
        • Basic Razor Syntax
        • Named Sections
        • Razor Cheatsheet
      • Rendering Content
      • Rendering Media
      • Partial Views
      • Partial View Macro Files
      • Stylesheets And JavaScript
    • Code
      • Service APIs
      • Subscribing To Notifications
      • Creating Forms
      • Debugging
        • Logging
      • Source Control
  • Implementation
    • Learn how Umbraco works
    • Routing
      • Controller & Action Selection
      • Execute Request
      • Request Pipeline
    • Custom Routing
      • Adding a hub with SignalR and Umbraco
    • Controllers
    • Data Persistence (CRUD)
    • Composing
    • Integration Testing
    • Nullable Reference Types
    • Services and Helpers
      • Circular Dependencies
    • Unit Testing
  • Extending
    • Customize the editing experience
    • Dashboards
    • Sections & Trees
      • Sections
      • Trees
        • Tree Actions
      • Searchable Trees (ISearchableTree)
    • Property Editors
      • Property Value Converters
      • Property Actions
      • Tracking References
      • Declaring your property editor
      • Content Picker Value Converter Example
    • Package Manifest
    • Macro Parameter Editors
    • Health Check
      • Health Check Guides
        • Click-Jacking Protection
        • Content/MIME Sniffing Protection
        • Cross-site scripting Protection (X-XSS-Protection header)
        • Debug Compilation Mode
        • Excessive Headers
        • Fixed Application Url
        • Folder & File Permissions
        • HTTPS Configuration
        • Macro Errors
        • Notification Email Settings
        • SMTP
        • Strict-Transport-Security Header
    • Language Files & Localization
    • Backoffice Search
    • Backoffice Tours
    • Backoffice UI API Documentation
    • Content Apps
    • Creating a Custom Database Table
    • Embedded Media Providers
    • Custom File Systems (IFileSystem)
      • Using Azure Blob Storage for Media and ImageSharp Cache
    • Configuring Azure Key Vault
    • Packages
      • Creating a Package
      • Language file for packages
      • Listing a Package on the Umbraco Marketplace
      • Good practice and defaults
      • Packages on Umbraco Cloud
      • Installing and Uninstalling Packages
      • Maintaining packages
      • Create accessible Umbraco packages
      • Example Package Repository
    • UI Library
  • Reference
    • Dive into the code
    • Configuration
      • Basic Authentication Settings
      • Connection strings settings
      • Content Dashboard Settings
      • Content Settings
      • Data Types Settings
      • Debug settings
      • Examine settings
      • Exception filter settings
      • FileSystemProviders Configuration
      • Global Settings
      • Health checks
      • Hosting settings
      • Imaging settings
      • Indexing settings
      • Install Default Data Settings
      • Keep alive settings
      • Logging settings
      • Maximum Upload Size Settings
      • Models builder settings
      • NuCache Settings
      • Package Migration
      • Plugins settings
      • Request handler settings
      • Rich text editor settings
      • Runtime minification settings
      • Runtime settings
      • Security Settings
      • Serilog settings
      • Tours settings
      • Type finder settings
      • Unattended
      • Web routing
    • Templating
      • Macros
        • Managing macros
        • Partial View Macros
      • Models Builder
        • Introduction
        • Configuration
        • Builder Modes
        • Understand and Extend
        • Using Interfaces
        • Tips and Tricks
      • Working with MVC
        • Working with MVC Views in Umbraco
        • View/Razor Examples
        • Using MVC Partial Views in Umbraco
        • Using View Components in Umbraco
        • Querying & Traversal
        • Creating Forms
    • Querying & Models
      • IMemberManager
      • IPublishedContentQuery
      • ITagQuery
      • UDI Identifiers
      • UmbracoContext helper
      • UmbracoHelper
      • IPublishedContent
        • IPublishedContent Collections
        • IPublishedContent IsHelpers
        • IPublishedContent Property Access & Extension Methods
    • Routing & Controllers
      • Routing requirements for backoffice authentication
      • Custom MVC controllers (Umbraco Route Hijacking)
      • Custom MVC Routes
      • Custom Middleware
      • URL Rewrites in Umbraco
      • Special Property Type aliases for routing
      • URL Redirect Management
      • Routing in Umbraco
        • FindPublishedContentAndTemplate()
        • IContentFinder
        • Inbound request pipeline
        • Outbound request pipeline
        • Published Content Request Preparation
      • Surface controllers
        • Surface controller actions
      • Umbraco API Controllers
        • Umbraco Api - Authorization
        • Umbraco Api - Routing & Urls
    • Content Delivery API
      • Custom property editors support
      • Extension API for querying
      • Media Delivery API
      • Protected content in the Delivery API
      • Output caching
      • Property expansion and limiting
      • Additional preview environments support
    • Webhooks
      • Expanding Webhook Events
    • API versioning and OpenAPI
    • Searching
      • Examine
        • Examine Management
        • Examine Manager
        • Custom indexing
        • PDF indexes and multisearchers
        • Quick-start
    • Using Notifications
      • Notification Handler
      • CacheRefresher Notifications Example
      • ContentService Notifications Example
      • Creating And Publishing Notifications
      • Determining if an entity is new
      • MediaService Notifications Example
      • MemberService Notifications Example
      • Sending Allowed Children Notification
      • Umbraco Application Lifetime Notifications
      • EditorModel Notifications
        • Customizing the "Links" box
      • Hot vs. cold restarts
    • Inversion of Control / Dependency injection
    • Management
      • Models Reference
        • Content
        • ContentType
        • DataType
        • DictionaryItem
        • Language
        • Media
        • MediaType
        • Relation
        • RelationType
        • ServerRegistration
        • Template
      • Services Reference
        • AuditService
        • ConsentService
        • DataTypeService
        • DomainService
        • EntityService
        • ExternalLoginService
        • FileService
        • MacroService
        • MediaService
        • MemberGroupService
        • MemberService
        • MemberTypeService
        • NotificationService
        • PackagingService
        • PublicAccessService
        • RedirectUrlService
        • RelationService
        • ServerRegistrationService
        • TagService
        • TextService
        • ContentService
          • Create content programmatically
          • Publish content programmatically
        • ContentTypeService
          • Retrieving content types
          • Retrieving content types
        • LocalizationService
          • Retrieving languages
        • UserService
          • Creating a user
    • Plugins
      • Creating Resolvers
      • Finding types
    • Cache & Distributed Cache
      • Accessing the cache
      • ICacheRefresher
      • IServerMessenger
      • Getting/Adding/Updating/Inserting Into Cache
      • Examples
        • Working with caching
    • Response Caching
    • Security
      • API rate limiting
      • BackOfficeUserManager and Events
      • Cookies
      • Replacing the basic username/password check
      • External login providers
      • Locking of Users and password reset
      • Reset admin password
      • Umbraco Security Hardening
      • Umbraco Security Settings
      • Sensitive data
      • Sanitizing the Rich Text Editor
      • Setup Umbraco for a FIPS Compliant Server
      • HTTPS
      • Two-factor Authentication
      • Server-side file validation
    • Scheduling
    • Common Pitfalls & Anti-Patterns
    • API Documentation
    • Debugging with SourceLink
    • Language Variation
    • UmbracoMapper
    • Distributed Locks
    • AngularJS
      • Directives
        • umbLayoutSelector
        • umbLoadIndicator
        • umbProperty
      • Services
        • Editor Service
        • Events Service
          • changeTitle
  • Tutorials
    • Overview
    • Creating a Basic Website
      • Getting Started
      • Document Types
      • Creating Your First Template
      • CSS and Images
      • Displaying the Document Type Properties
      • Creating a Master Template
      • Creating Pages and Using the Master Template
      • Setting the Navigation Menu
      • Articles and Article Items
      • Adding Language Variants
      • Conclusions
    • Creating a Custom Dashboard
      • Extending the Dashboard using the Umbraco UI library
    • Creating a Property Editor
      • Adding configuration to a property editor
      • Integrating services with a property editor
      • Adding server-side data to a property editor
    • Creating a Multilingual Site
    • Add Google Authentication (Users)
    • Add Microsoft Entra ID authentication (Members)
    • Creating a Backoffice Tour
    • Creating Custom Database Tables with Entity Framework
    • The Starter Kit
      • Lessons
        • Customize the Starter Kit
        • Add a Blog Post Publication Date
          • Add a Blog Post Publication Date
          • Add a Blog Post Publication Date
        • Add Open Graph
          • Add Open Graph - Step 1
          • Add Open Graph - Step 2
          • Add Open Graph - Step 3
          • Add Open Graph - Step 4
          • Add Open Graph - Summary
        • Ask For Help and Join the Community
    • Editor's Manual
      • Getting Started
        • Logging In and Out
        • Umbraco Interface
        • Creating, Saving and Publishing Content Options
        • Finding Content
        • Editing Existing Content
        • Sorting Pages
        • Moving a Page
        • Copying a Page
        • Deleting and Restoring Pages
      • Working with Rich Text Editor
      • Version Management
        • Comparing Versions
        • Rollback to a Previous Version
      • Media Management
        • Working with Folders
        • Working with Media Types
        • Cropping Images
      • Tips & Tricks
        • Refreshing the Tree View
        • Audit Trail
        • Notifications
        • Preview Pane Responsive View
        • Session Timeout
    • Multisite Setup
    • Member Registration and Login
    • Custom Views for Block List
    • Connecting Umbraco Forms and Zapier
    • Creating an XML Sitemap
    • Implementing Custom Error Pages
Powered by GitBook
On this page
  • Sample Manifest
  • Sample Manifest with Csharp
  • Root elements
  • Telemetry elements
  • Property Editors
  • Editor
  • Pre Values
  • Default Config
  • Grid Editors
  • Parameter Editors
  • JavaScript
  • CSS
  • Bundling
  • JSON Schema
  • Setting up Visual Studio 2015+
  • Setting up JetBrains Rider 2019+
  • Setting up Visual Studio Code
  • Adding inline schema
Edit on GitHub
Export as PDF
  1. Extending

Package Manifest

The package.manifest JSON file format is used to describe one or more custom Umbraco property editors, grid editors or parameter editors. This page outlines the file format and properties found in the JSON.

Sample Manifest

This is a sample manifest, it is always stored in a folder in /App_Plugins/{YourPackageName}, with the name package.manifest

{
    "name": "Suggestions",
    "version": "1.0.0 beta",
    "allowPackageTelemetry": true,
    "bundleOptions": "Default",
    "packageView": "/App_Plugins/Suggestions/suggestion-config.html",
    "propertyEditors": [
        {
            "alias": "Suggestions",
            "name": "Suggestions",
            "editor": {
                "view": "/App_Plugins/Suggestions/suggestion.html",
                "hideLabel": true,
                "valueType": "JSON",
                "supportsReadOnly": true
            }
        }
    ],
    "javascript": [
        "/App_Plugins/Suggestions/suggestion.controller.js"
    ]
}

Sample Manifest with Csharp

You can also register your files by implementing a IManifestFilter instead of creating a package.manifest. Create a ManifestFilter.cs file and implement the IManifestFilter interface. Then define the composer using the IComposer interface.

using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.Manifest;
using Umbraco.Cms.Core.PropertyEditors;

namespace MyProject
{
	public class ManifestComposer : IComposer
	{
		//composer
		public void Compose(IUmbracoBuilder builder)
		{
			builder.ManifestFilters().Append<ManifestFilter>();
		}
	}
	public class ManifestFilter : IManifestFilter
	{
		private readonly IDataValueEditorFactory _dataValueEditorFactory;

		public ManifestFilter(IDataValueEditorFactory dataValueEditorFactory)
		{
			_dataValueEditorFactory = dataValueEditorFactory;
		}

		public void Filter(List<PackageManifest> manifests)
		{
			manifests.Add(new PackageManifest
			{
				PackageName = "Suggestions",
				Scripts = new[]
				{
					"/App_Plugins/Suggestions/suggestion.controller.js"
				},				
				Version = "1.0.0"
			});
		}
	}
}

Root elements

The manifest can contain seven root collections, none of them are mandatory:

{
    "propertyEditors": [],
    "gridEditors": [],
    "parameterEditors": [],
    "dashboards": [],
    "sections": [],
    "contentApps": [],
    "javascript": [],
    "css": []
}

Telemetry elements

From version 9.2, some additional root elements were added. Their purpose is to control and facilitate telemetry for the package but none of these are mandatory. The properties are:

  • name - Allows you to specify a friendly name for your package that will be used for telemetry, if no name is specified the name of the folder will be used instead

  • version - The version of your package, if this is not specified there will be no version specific information for your package

  • allowPackageTelemetry - Allows you to entirely disable telemetry for your package if set to false, defaults to true.

Example package.manifest

{
    "name": "My Awesome Package",
    "version": "1.0.0",
    "allowPackageTelemetry": true
}

Property Editors

propertyEditors returns an array of property editor definitions, 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. They can also be made available as a macro parameter editor.

The basic values on any editor are alias, name and editor. These three must be set. Furthermore the editor value is an object with additional configuration options, it must contain a view value.

{
    "alias": "my.editor.alias",
    "name": "My friendly editor name",
    "editor": {
        "view": "/App_Plugins/MyEditorName/view.html"
    },
    "prevalues": {
        "fields": []
    }
}
  • alias The alias of the editor, this must be unique, its recommended to prefix with your own "namespace".

  • name The name visible to the user in the UI, should also be unique.

  • editor Object containing editor configuration (see below).

  • isParameterEditor enables the property editor as a macro parameter editor can be true/false.

  • prevalues Configuration of editor prevalues (see below).

  • defaultConfig Default configuration values (see below).

  • icon A CSS class for the icon to be used in the 'Select Editor' dialog: e.g. icon-autofill.

  • group 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.

  • defaultConfig Provides a collection of default configuration values, in case the property editor is not configured or is using a parameter editor, which doesn't allow configuration. The object is a key/value collection and must match the prevalues fields keys.

Editor

editor Besides setting a view, the editor can also contain additional information.

"editor": {
    "view": "/App_Plugins/MyEditorName/view.html",
    "hideLabel": true,
    "valueType": "TEXT",
    "validation": {},
    "supportsReadOnly": true,
    "isReadOnly": false
}
  • view Path to the HTML file to use for rendering the editor.

  • hideLabel Turn the label on or off by using true or false, respectively.

  • valueType Sets the database type the value is stored as, by default it's string.

  • validation Object describing required validators on the editor.

  • supportsReadOnly Sets whether the editor supports read-only mode, if set to true, the editor is expected to have its own implementation of the read-only mode.

  • isReadOnly Disables editing the value.

valueType sets the kind of data the editor will save in the database, its default setting is string. The available options are:

  • STRING Stores the value as an nvarchar in the database

  • DATETIME Stores the value as datetime in the database

  • TEXT Stores the value as ntext in the database

  • INT Stores the value as a bigint in the database

  • JSON Stored as ntext and automatically serialized to a dynamic object

Pre Values

preValues is a collection of prevalue editors, used for configuring the property editor, the prevalues object must return an array of editors, called fields.

"prevalues": {
    "fields": [
        {
            "label": "Enable something",
            "description": "This is a description",
            "key": "enableStuff",
            "view": "boolean"
        }
    ]
}

Each field contains a number of configuration values:

  • label The label shown on the Data Type configuration screen

  • description Help text displayed underneath the label

  • key The key the prevalue is stored under (see below)

  • view Path to the editor used to configure this prevalue (see below)

key on a prevalue, determines where it's stored in the database. If you give your prevalue the key "wolf" then this key will be used in the prevalue table.

It also means when this property editor is used on a property, the prevalue will be exposed on the model's configuration object. This occurs inside the property editor's controller, as shown below:

// this is the property value
$scope.model.value = "hello";

// this is the configuration on the property editor
$scope.model.config

// this is our specific prevalue with the alias wolf
$scope.model.config.wolf

view config value points the prevalue editor to an editor to use. This follows the same concept as any other editor in Umbraco, but with prevalue editors there are a couple of conventions.

If you specify a name like boolean then Umbraco will look at /wwwroot/umbraco/views/prevalueeditors/boolean/boolean.html for the editor view. If you wish to use your own, you specify the path like /App_Plugins/{YourPackageName}/prevalue-editor.html.

Default Config

The defaultConfig object provides a collection of default configuration values in case the property editor is not configured or is using a parameter editor. This object is a key/value collection and must match the prevalue field keys.

"defaultConfig": {
    "wolf": "nope",
    "editor": "hello",
    "random": 1234
}

Grid Editors

Similar to how the propertyEditors array defines one or more property editors, gridEditors can be used to define editors specific to the grid. Setting up the default richtext editor in the Umbraco grid could look like:

{
  "gridEditors": [
    {
      "name": "Rich text editor",
      "alias": "rte",
      "view": "rte",
      "icon": "icon-article"
    }
  ]
}

Parameter Editors

parameterEditors 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.

The parameter editors array follows the same format as the property editors described above. However, it cannot contain prevalues since there are no configuration options for macro parameter editors.

JavaScript

javascript returns a string[] of JavaScript files to load on application start

{
  "javascript": [
    "/App_Plugins/MyEditorName/MyEditorName.controller.js",
    "/App_Plugins/MyEditorName/MyEditorName.js"
  ]
}

CSS

css returns a string[] of css files to load on application start

{
  "css": [
    "/App_Plugins/MyEditorName/MyEditorName.css",
    "/App_Plugins/MyEditorName/hibba.css"
  ]
}

Bundling

bundleOptions is an enumerable type that expects one of the following values:

  • Default - The default bundling behavior for assets in the package folder where 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 and will effectively be a bundle that has composite processing turned off for both debug and production.

  • Independent - The packages assets will be processed as its own separate bundle. (In debug, files will not be processed)

JSON Schema

The package.manifest JSON file has a hosted online JSON schema file. This allows editors such as Visual Studio, Rider, and Visual Studio Code to have autocomplete/intellisense support when creating and editing package.manifest files. This helps to avoid mistakes or errors when creating your package.manifest files.

Setting up Visual Studio 2015+

To associate the hosted JSON schema file to all package.manifest files you will need to perform the following inside of Visual Studio 2015.

  • Tools -> Options

  • Browse down to Text Editor -> File Extension

  • Add manifest into the Extension box

  • Select JSON Editor from the dropdown and add the mapping

  • Open a package.manifest file and ensure in the top left hand corner you see the schema with the URL set to http://json.schemastore.org/package.manifest. You can also add the schema inline in the json file (see below).

Setting up JetBrains Rider 2019+

To associate the hosted JSON schema file to all package.manifest files you will need to perform the following inside of JetBrains Rider 2019+.

  • File -> Settings

  • Browse down to Editor -> File Types -> JSON

  • Add package.manifest to the list of file pattern names.

  • Browse down to Languages & Frameworks -> Schemas and DTDs -> JSON Schema Mappings

  • Add new by clicking the + symbol

  • Add package.manifest as Name

  • Add https://json.schemastore.org/package.manifest as the Schema File or URL, or choose package.manifest from the Remote Schema URls

  • Add package.manifest as File path pattern

  • Open a package.manifest file and ensure in the bottom tool bar you see the schema is detected as package.manifest.

Setting up Visual Studio Code

To associate the hosted JSON schema file to all package.manifest files you will need to perform the following inside of Visual Studio Code editor.

  • File -> Preferences -> Settings. The Settings window opens.

  • In the User tab, go to Extensions -> JSON -> Schemas.

  • Select Edit in settings.json from the Schemas section.

  • Add the following snippet in the settings.json file:

    {
        "json.schemas": [
            {
                "fileMatch": [
                    "manifest.json"
                ],
                "url": "http://json.schemastore.org/package.manifest"
            }
        ]
    }

Adding inline schema

Editors like Visual Studio can use the $schema notation in your file.

{
    "$schema" : "http://json.schemastore.org/package.manifest",
    "javascript": [],
    "other properties": ""
}
PreviousContent Picker Value Converter ExampleNextMacro Parameter Editors

Last updated 6 months ago

For a functional example, you will need to register the editor and create the HTML, JS, and CSS files in the App_Plugins/Suggestions folder. You can find some examples of registering the editor in the Suggestions.cs file and within the files in the App_Plugins folder. For more information, see the .

However the default grid editors are already configured. You can see the for more information on grid editors.

Creating a Property Editor article
Grid Editors page