This is our starter project for an Umbraco Property Editor.
Click the Use this template button to create a new copy of this repository in your own account. Then clone that new repository down to your local machine and get started:
-
Find the
src/package.ent
file and change the constants in there -
You may want to change a few things in the
package.xml
andmanifest.xml
files as well -
Look for
TODO
,EDITOR_NAME
andEDITOR_ALIAS
in various files and change accordingly -
Edit/add/remove files in the
src/
folder and update the files section in thepackage.xml
file -
Edit the
PropertyConverterV(7|8).cs
files as well -
Edit this README to describe your new property editor :)
-
Create an entry for your new package on Our Umbraco
On macOS you can run the build.sh
script from the terminal, which will
build a ZIP file in the dist
folder that is installable from
Umbraco 8's Packages section or Umbraco 7's Developer > Packages section.
The build script versions the files so it's easier to test the package inside an Umbraco installation by uninstalling the existing version and then installing a new build. Existing data-types keep their data as long as their alias and/or storage type isn't changed.
To update the version number, increment the packageVersion
entity in the
src/package.ent
file.