Add note regarding required directus:extension field to extension docs (#7099)

Fixes #7072
This commit is contained in:
Nicola Krumschmidt
2021-07-30 18:00:02 +02:00
committed by GitHub
parent e2c163979f
commit e05470ecc7
4 changed files with 52 additions and 0 deletions

View File

@@ -103,6 +103,19 @@ SDK, run this command:
npm i -D @directus/extension-sdk
```
For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to
the root of the `package.json` file:
```json
"directus:extension": {
"type": "display",
"path": "dist/index.js",
"source": "src/index.js",
"host": "^9.0.0-rc.87",
"hidden": false
}
```
## 3. Develop Your Custom Display
The display itself is simply a function or a Vue component, providing a blank canvas for creating anything you need.

View File

@@ -94,6 +94,19 @@ SDK, run this command:
npm i -D @directus/extension-sdk
```
For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to
the root of the `package.json` file:
```json
"directus:extension": {
"type": "interface",
"path": "dist/index.js",
"source": "src/index.js",
"host": "^9.0.0-rc.87",
"hidden": false
}
```
## 3. Develop your Custom Interface
The interface itself is simply a Vue component, which provides an blank canvas for creating anything you need.

View File

@@ -99,6 +99,19 @@ SDK, run this command:
npm i -D @directus/extension-sdk
```
For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to
the root of the `package.json` file:
```json
"directus:extension": {
"type": "layout",
"path": "dist/index.js",
"source": "src/index.js",
"host": "^9.0.0-rc.87",
"hidden": false
}
```
## 3. Develop Your Custom Layout
The layout itself is simply a Vue component, which provides an blank canvas for creating anything you need.

View File

@@ -136,6 +136,19 @@ SDK, run this command:
npm i -D @directus/extension-sdk
```
For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to
the root of the `package.json` file:
```json
"directus:extension": {
"type": "module",
"path": "dist/index.js",
"source": "src/index.js",
"host": "^9.0.0-rc.87",
"hidden": false
}
```
## 3. Develop Your Custom Module
The module itself is simply a Vue component, which provides an blank canvas for creating anything you need.