Where to start for first Umbraco 17 package?

Questions
,
1

I am about to embrak on writting my first package for Umbraco and am going to target v17. I am looking for advice for someone who has never written a package or done any extending of Umbraco. I know I am going to have to learn TypeScript (I think that is what it is called) for the backoffice and I think I once saw someone had like a starter template that might help a good place to start?

Any advice would be apreceated. The package will need it’s own tab in the backoffice and will also allow new properties to be added to document types.

Thanks

2

hey matthew :waving_hand:

Great :raising_hands: welcome to the fun side of Umbraco :grinning_face_with_smiling_eyes: :umbraco-heart:

I’d suggest starting small:

  • Create a basic custom section (just render something simple).

  • Then explore adding a property editor.

  • Use existing packages like Kevin Jump’s examples as reference they’re super helpful for structure.

don’t try to build everything at once. Get one small piece working, then expand from there.

u can follow these examples structural inspiration Edit: (Note These examples are not specifically for v17):

and hey if u can set this up : GitHub - umbraco/Umbraco-CMS-Backoffice-Skills this will really help u if ur working with ai tools like claude , cursor. and we’re always here on the forum to help

goodluck

3

I am going to be contrarian and say please do not start there, they are very outdated and you’ll get frustrated.

Up to date docs are here:

Use the Umbraco Extension template which will give you a few working examples too:

And as noted, AI Skills are in beta and they can greatly accelerate what you’re trying to do:

The skills are initially designed to work with Claude but I understand other LLMs can use them as well.

4

oopsee🫣

I mainly mentioned those as structural inspiration as myself started from those, but you’re absolutely right for v17 it’s much better to start from the latest docs and current extension patterns

5

And if you want to get a leg up/quick start to see how things are working rather than spending loads of time setting up your development environment for the package then…

LottePitcher/opinionated-package-starter: Get a head start when creating Umbraco Packages

(mentioned in the docs too Umbraco Extension Template | CMS | Umbraco Documentation )

the docs tend to be super simple set up one dashboard, one property editor when you very quickly expand out and the opinionated-package-starter has the infrastructure there for multiple components in your package… as well as a test site, and the release cycle too!

1 Like
7

Thanks this is what I was trying to remember for a template. I will start with getting that setup. Good to know that it has a test site to, I had forgoten to ask about that part.

8

Thanks for the links to the docs. I will defeinatly be going thought them. I don’t want to use AI in my projects but thanks for linking that resource.

9

This might also help a little (code samples are up to date for v17 latest), it is not 100% complete as the article is still a work in progress but may be of use (give me a shout if you have questions)

Building a Custom Polls Feature in Umbraco 17 Backoffice