client/src/app/shared/shared-main/misc/help.component.ts

   1 import { AfterContentInit, Component, ContentChildren, Input, OnChanges, OnInit, QueryList, TemplateRef } from '@angular/core'
   2 import { MarkdownService } from '@app/core'
   3 import { GlobalIconName } from '@app/shared/shared-icons'
   4 import { PeerTubeTemplateDirective } from '../angular'
   5
   6 @Component({
   7   selector: 'my-help',
   8   styleUrls: [ './help.component.scss' ],
   9   templateUrl: './help.component.html'
  10 })
  11
  12 export class HelpComponent implements OnInit, OnChanges, AfterContentInit {
  13   @Input() helpType: 'custom' | 'markdownText' | 'markdownEnhanced' = 'custom'
  14   @Input() tooltipPlacement = 'right auto'
  15   @Input() iconName: GlobalIconName = 'help'
  16   @Input() title = $localize`Get help`
  17
  18   @ContentChildren(PeerTubeTemplateDirective) templates: QueryList<PeerTubeTemplateDirective<'preHtml' | 'customHtml' | 'postHtml'>>
  19
  20   isPopoverOpened = false
  21   mainHtml = ''
  22
  23   preHtmlTemplate: TemplateRef<any>
  24   customHtmlTemplate: TemplateRef<any>
  25   postHtmlTemplate: TemplateRef<any>
  26
  27   ngOnInit () {
  28     this.init()
  29   }
  30
  31   ngAfterContentInit () {
  32     {
  33       const t = this.templates.find(t => t.name === 'preHtml')
  34       if (t) this.preHtmlTemplate = t.template
  35     }
  36
  37     {
  38       const t = this.templates.find(t => t.name === 'customHtml')
  39       if (t) this.customHtmlTemplate = t.template
  40     }
  41
  42     {
  43       const t = this.templates.find(t => t.name === 'postHtml')
  44       if (t) this.postHtmlTemplate = t.template
  45     }
  46   }
  47
  48   ngOnChanges () {
  49     this.init()
  50   }
  51
  52   onPopoverHidden () {
  53     this.isPopoverOpened = false
  54   }
  55
  56   onPopoverShown () {
  57     this.isPopoverOpened = true
  58   }
  59
  60   private init () {
  61     if (this.helpType === 'markdownText') {
  62       this.mainHtml = this.formatMarkdownSupport(MarkdownService.TEXT_RULES)
  63       return
  64     }
  65
  66     if (this.helpType === 'markdownEnhanced') {
  67       this.mainHtml = this.formatMarkdownSupport(MarkdownService.ENHANCED_RULES)
  68       return
  69     }
  70   }
  71
  72   private formatMarkdownSupport (rules: string[]) {
  73     // tslint:disable:max-line-length
  74     return $localize`<a href="https://en.wikipedia.org/wiki/Markdown#Example" target="_blank" rel="noopener noreferrer">Markdown</a> compatible that supports:` +
  75       this.createMarkdownList(rules)
  76   }
  77
  78   private createMarkdownList (rules: string[]) {
  79     const rulesToText = {
  80       'emphasis': $localize`Emphasis`,
  81       'link': $localize`Links`,
  82       'newline': $localize`New lines`,
  83       'list': $localize`Lists`,
  84       'image': $localize`Images`
  85     }
  86
  87     const bullets = rules.map(r => rulesToText[r])
  88       .filter(text => text)
  89       .map(text => '<li>' + text + '</li>')
  90       .join('')
  91
  92     return '<ul>' + bullets + '</ul>'
  93   }
  94 }