Skip to content

Commit a24001e

Browse files
Add documentation for Umbraco Forms NPM package
1 parent e1305ba commit a24001e

File tree

1 file changed

+16
-1
lines changed
  • 16/umbraco-forms/developer/extending

1 file changed

+16
-1
lines changed

16/umbraco-forms/developer/extending/README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
# Extending
22

3-
Umbraco Forms functionality can be extended in different ways. In this section we focus on techniques available to a back-end/C# developer.
3+
Umbraco Forms functionality can be extended in different ways.
44

55
For front-end extensions, specifically via theming, see the [Themes](../themes.md) section.
66

7+
## Extending the Backoffice
8+
Umbraco Forms publishes an NPM package called `@umbraco-forms/backoffice` that holds typings and other niceties to build extensions.
9+
10+
{% hint style="warning" %}
11+
Ensure that you install the version of the Backoffice package compatible with your Umbraco Forms installation. You can find the appropriate version on the [@umbraco-forms/backoffice npm page](https://www.npmjs.com/package/@umbraco-forms/backoffice).
12+
{% endhint %}
13+
14+
You can install this package by running the command:
15+
16+
```bash
17+
npm install -D @umbraco-forms/[email protected]
18+
```
19+
20+
This will add a package to your devDependencies containing the TypeScript definitions for Umbraco Forms.
21+
722
## Developing Custom Providers
823

924
Although the Forms package comes with many fields, workflows and other built-in types, you can still create and develop your own if needed.

0 commit comments

Comments
 (0)