diff options
5 files changed, 51 insertions, 1 deletions
diff --git a/client/src/app/+admin/plugins/plugin-show-installed/plugin-show-installed.component.html b/client/src/app/+admin/plugins/plugin-show-installed/plugin-show-installed.component.html index 95dd74d31..bf135ecbd 100644 --- a/client/src/app/+admin/plugins/plugin-show-installed/plugin-show-installed.component.html +++ b/client/src/app/+admin/plugins/plugin-show-installed/plugin-show-installed.component.html | |||
@@ -8,9 +8,27 @@ | |||
8 | <form *ngIf="hasRegisteredSettings()" role="form" (ngSubmit)="formValidated()" [formGroup]="form"> | 8 | <form *ngIf="hasRegisteredSettings()" role="form" (ngSubmit)="formValidated()" [formGroup]="form"> |
9 | <div class="form-group" *ngFor="let setting of registeredSettings"> | 9 | <div class="form-group" *ngFor="let setting of registeredSettings"> |
10 | <label *ngIf="setting.type !== 'input-checkbox'" [attr.for]="setting.name" [innerHTML]="setting.label"></label> | 10 | <label *ngIf="setting.type !== 'input-checkbox'" [attr.for]="setting.name" [innerHTML]="setting.label"></label> |
11 | |||
11 | <input *ngIf="setting.type === 'input'" type="text" [id]="setting.name" [formControlName]="setting.name" /> | 12 | <input *ngIf="setting.type === 'input'" type="text" [id]="setting.name" [formControlName]="setting.name" /> |
13 | |||
12 | <textarea *ngIf="setting.type === 'input-textarea'" type="text" [id]="setting.name" [formControlName]="setting.name"></textarea> | 14 | <textarea *ngIf="setting.type === 'input-textarea'" type="text" [id]="setting.name" [formControlName]="setting.name"></textarea> |
13 | 15 | ||
16 | <my-help *ngIf="setting.type === 'markdown-text'" helpType="markdownText"></my-help> | ||
17 | |||
18 | <my-help *ngIf="setting.type === 'markdown-enhanced'" helpType="markdownEnhanced"></my-help> | ||
19 | |||
20 | <my-markdown-textarea | ||
21 | *ngIf="setting.type === 'markdown-text'" | ||
22 | markdownType="text" [id]="setting.name" [formControlName]="setting.name" textareaWidth="500px" [previewColumn]="false" | ||
23 | [classes]="{ 'input-error': formErrors['settings.name'] }" | ||
24 | ></my-markdown-textarea> | ||
25 | |||
26 | <my-markdown-textarea | ||
27 | *ngIf="setting.type === 'markdown-enhanced'" | ||
28 | markdownType="enhanced" [id]="setting.name" [formControlName]="setting.name" textareaWidth="500px" [previewColumn]="false" | ||
29 | [classes]="{ 'input-error': formErrors['settings.name'] }" | ||
30 | ></my-markdown-textarea> | ||
31 | |||
14 | <my-peertube-checkbox | 32 | <my-peertube-checkbox |
15 | *ngIf="setting.type === 'input-checkbox'" | 33 | *ngIf="setting.type === 'input-checkbox'" |
16 | [id]="setting.name" | 34 | [id]="setting.name" |
diff --git a/client/src/app/core/plugins/plugin.service.ts b/client/src/app/core/plugins/plugin.service.ts index 039fd6ff1..3ed23160d 100644 --- a/client/src/app/core/plugins/plugin.service.ts +++ b/client/src/app/core/plugins/plugin.service.ts | |||
@@ -15,6 +15,7 @@ import { HttpClient } from '@angular/common/http' | |||
15 | import { AuthService } from '@app/core/auth' | 15 | import { AuthService } from '@app/core/auth' |
16 | import { Notifier } from '@app/core/notification' | 16 | import { Notifier } from '@app/core/notification' |
17 | import { RestExtractor } from '@app/shared/rest' | 17 | import { RestExtractor } from '@app/shared/rest' |
18 | import { MarkdownService } from '@app/shared/renderer' | ||
18 | import { PluginType } from '@shared/models/plugins/plugin.type' | 19 | import { PluginType } from '@shared/models/plugins/plugin.type' |
19 | import { PublicServerSetting } from '@shared/models/plugins/public-server.setting' | 20 | import { PublicServerSetting } from '@shared/models/plugins/public-server.setting' |
20 | import { getDevLocale, isOnDevLocale } from '@app/shared/i18n/i18n-utils' | 21 | import { getDevLocale, isOnDevLocale } from '@app/shared/i18n/i18n-utils' |
@@ -65,6 +66,7 @@ export class PluginService implements ClientHook { | |||
65 | private router: Router, | 66 | private router: Router, |
66 | private authService: AuthService, | 67 | private authService: AuthService, |
67 | private notifier: Notifier, | 68 | private notifier: Notifier, |
69 | private markdownRenderer: MarkdownService, | ||
68 | private server: ServerService, | 70 | private server: ServerService, |
69 | private zone: NgZone, | 71 | private zone: NgZone, |
70 | private authHttp: HttpClient, | 72 | private authHttp: HttpClient, |
@@ -297,6 +299,16 @@ export class PluginService implements ClientHook { | |||
297 | this.customModal.show(input) | 299 | this.customModal.show(input) |
298 | }, | 300 | }, |
299 | 301 | ||
302 | markdownRenderer: { | ||
303 | textMarkdownToHTML: (textMarkdown: string) => { | ||
304 | return this.markdownRenderer.textMarkdownToHTML(textMarkdown) | ||
305 | }, | ||
306 | |||
307 | enhancedMarkdownToHTML: (enhancedMarkdown: string) => { | ||
308 | return this.markdownRenderer.enhancedMarkdownToHTML(enhancedMarkdown) | ||
309 | } | ||
310 | }, | ||
311 | |||
300 | translate: (value: string) => { | 312 | translate: (value: string) => { |
301 | return this.translationsObservable | 313 | return this.translationsObservable |
302 | .pipe(map(allTranslations => allTranslations[npmName])) | 314 | .pipe(map(allTranslations => allTranslations[npmName])) |
diff --git a/client/src/types/register-client-option.model.ts b/client/src/types/register-client-option.model.ts index 1c235107a..dff00e9dd 100644 --- a/client/src/types/register-client-option.model.ts +++ b/client/src/types/register-client-option.model.ts | |||
@@ -27,5 +27,10 @@ export type RegisterClientHelpers = { | |||
27 | confirm?: { value: string, action?: () => void } | 27 | confirm?: { value: string, action?: () => void } |
28 | }) => void | 28 | }) => void |
29 | 29 | ||
30 | markdownRenderer: { | ||
31 | textMarkdownToHTML: (textMarkdown: string) => Promise<string> | ||
32 | enhancedMarkdownToHTML: (enhancedMarkdown: string) => Promise<string> | ||
33 | } | ||
34 | |||
30 | translate: (toTranslate: string) => Promise<string> | 35 | translate: (toTranslate: string) => Promise<string> |
31 | } | 36 | } |
diff --git a/shared/models/plugins/register-server-setting.model.ts b/shared/models/plugins/register-server-setting.model.ts index 45d79228d..ec175e9ef 100644 --- a/shared/models/plugins/register-server-setting.model.ts +++ b/shared/models/plugins/register-server-setting.model.ts | |||
@@ -1,7 +1,7 @@ | |||
1 | export interface RegisterServerSettingOptions { | 1 | export interface RegisterServerSettingOptions { |
2 | name: string | 2 | name: string |
3 | label: string | 3 | label: string |
4 | type: 'input' | 'input-checkbox' | 'input-textarea' | 4 | type: 'input' | 'input-checkbox' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' |
5 | 5 | ||
6 | // If the setting is not private, anyone can view its value (client code included) | 6 | // If the setting is not private, anyone can view its value (client code included) |
7 | // If the setting is private, only server-side hooks can access it | 7 | // If the setting is private, only server-side hooks can access it |
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index e6870ce17..1bee1f611 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md | |||
@@ -149,6 +149,7 @@ registerSetting({ | |||
149 | name: 'admin-name', | 149 | name: 'admin-name', |
150 | label: 'Admin name', | 150 | label: 'Admin name', |
151 | type: 'input', | 151 | type: 'input', |
152 | // type: input | input-checkbox | input-textarea | markdown-text | markdown-enhanced | ||
152 | default: 'my super name' | 153 | default: 'my super name' |
153 | }) | 154 | }) |
154 | 155 | ||
@@ -216,6 +217,20 @@ notifier.success('Success message content.') | |||
216 | notifier.error('Error message content.') | 217 | notifier.error('Error message content.') |
217 | ``` | 218 | ``` |
218 | 219 | ||
220 | #### Markdown Renderer | ||
221 | |||
222 | To render a formatted markdown text to HTML: | ||
223 | |||
224 | ```js | ||
225 | const { markdownRenderer } = peertubeHelpers | ||
226 | |||
227 | await markdownRenderer.textMarkdownToHTML('**My Bold Text**') | ||
228 | // return <strong>My Bold Text</strong> | ||
229 | |||
230 | await markdownRenderer.enhancedMarkdownToHTML('![alt-img](http://.../my-image.jpg)') | ||
231 | // return <img alt=alt-img src=http://.../my-image.jpg /> | ||
232 | ``` | ||
233 | |||
219 | #### Custom Modal | 234 | #### Custom Modal |
220 | 235 | ||
221 | To show a custom modal: | 236 | To show a custom modal: |