@eui/ecl 21.0.0-alpha.11 → 21.0.0-alpha.12

package/docs/template-playground/default-templates.json

@@ -0,0 +1,192 @@
+{
+  "templates": [
+    {
+      "name": "page.hbs",
+      "path": "page.hbs",
+      "description": "Main page template - the base layout for all documentation pages",
+      "type": "hbs",
+      "category": "core",
+      "content": "<!-- This will be populated with the actual page.hbs content -->"
+    },
+    {
+      "name": "component.hbs",
+      "path": "partials/component.hbs",
+      "description": "Component detail template - displays Angular component documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual component.hbs content -->"
+    },
+    {
+      "name": "module.hbs",
+      "path": "partials/module.hbs",
+      "description": "Module detail template - displays Angular module documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual module.hbs content -->"
+    },
+    {
+      "name": "overview.hbs",
+      "path": "partials/overview.hbs",
+      "description": "Overview template - displays the main overview page",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual overview.hbs content -->"
+    },
+    {
+      "name": "class.hbs",
+      "path": "partials/class.hbs",
+      "description": "Class detail template - displays TypeScript class documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual class.hbs content -->"
+    },
+    {
+      "name": "interface.hbs",
+      "path": "partials/interface.hbs",
+      "description": "Interface detail template - displays TypeScript interface documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual interface.hbs content -->"
+    },
+    {
+      "name": "injectable.hbs",
+      "path": "partials/injectable.hbs",
+      "description": "Injectable service template - displays Angular service documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual injectable.hbs content -->"
+    },
+    {
+      "name": "directive.hbs",
+      "path": "partials/directive.hbs",
+      "description": "Directive template - displays Angular directive documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual directive.hbs content -->"
+    },
+    {
+      "name": "pipe.hbs",
+      "path": "partials/pipe.hbs",
+      "description": "Pipe template - displays Angular pipe documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual pipe.hbs content -->"
+    },
+    {
+      "name": "guard.hbs",
+      "path": "partials/guard.hbs",
+      "description": "Guard template - displays Angular guard documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual guard.hbs content -->"
+    },
+    {
+      "name": "interceptor.hbs",
+      "path": "partials/interceptor.hbs",
+      "description": "Interceptor template - displays Angular interceptor documentation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual interceptor.hbs content -->"
+    },
+    {
+      "name": "menu.hbs",
+      "path": "partials/menu.hbs",
+      "description": "Navigation menu template - displays the sidebar navigation",
+      "type": "hbs",
+      "category": "partials",
+      "content": "<!-- This will be populated with the actual menu.hbs content -->"
+    }
+  ],
+  "styles": [
+    {
+      "name": "compodoc.css",
+      "path": "styles/compodoc.css",
+      "description": "Main stylesheet - contains the core styles for Compodoc",
+      "type": "css",
+      "category": "core",
+      "content": "/* This will be populated with the actual compodoc.css content */"
+    },
+    {
+      "name": "bootstrap.min.css",
+      "path": "styles/bootstrap.min.css",
+      "description": "Bootstrap CSS framework - provides base styling components",
+      "type": "css",
+      "category": "vendor",
+      "content": "/* This will be populated with the actual bootstrap.min.css content */"
+    },
+    {
+      "name": "dark.css",
+      "path": "styles/dark.css",
+      "description": "Dark mode styles - contains dark theme styling",
+      "type": "css",
+      "category": "theme",
+      "content": "/* This will be populated with the actual dark.css content */"
+    },
+    {
+      "name": "gitbook.css",
+      "path": "styles/gitbook.css",
+      "description": "GitBook theme styles - alternative theme styling",
+      "type": "css",
+      "category": "theme",
+      "content": "/* This will be populated with the actual gitbook.css content */"
+    },
+    {
+      "name": "material.css",
+      "path": "styles/material.css",
+      "description": "Material design theme styles - Material theme styling",
+      "type": "css",
+      "category": "theme",
+      "content": "/* This will be populated with the actual material.css content */"
+    }
+  ],
+  "scripts": [
+    {
+      "name": "compodoc.js",
+      "path": "js/compodoc.js",
+      "description": "Main JavaScript file - contains core Compodoc functionality",
+      "type": "js",
+      "category": "core",
+      "content": "// This will be populated with the actual compodoc.js content"
+    },
+    {
+      "name": "menu.js",
+      "path": "js/menu.js",
+      "description": "Menu functionality - handles navigation menu interactions",
+      "type": "js",
+      "category": "core",
+      "content": "// This will be populated with the actual menu.js content"
+    },
+    {
+      "name": "tabs.js",
+      "path": "js/tabs.js",
+      "description": "Tab functionality - handles tab navigation in documentation pages",
+      "type": "js",
+      "category": "core",
+      "content": "// This will be populated with the actual tabs.js content"
+    },
+    {
+      "name": "search.js",
+      "path": "js/search/search.js",
+      "description": "Search functionality - handles documentation search features",
+      "type": "js",
+      "category": "feature",
+      "content": "// This will be populated with the actual search.js content"
+    },
+    {
+      "name": "sourceCode.js",
+      "path": "js/sourceCode.js",
+      "description": "Source code display - handles syntax highlighting and code display",
+      "type": "js",
+      "category": "feature",
+      "content": "// This will be populated with the actual sourceCode.js content"
+    },
+    {
+      "name": "lazy-load-graphs.js",
+      "path": "js/lazy-load-graphs.js",
+      "description": "Graph loading - handles lazy loading of dependency graphs",
+      "type": "js",
+      "category": "feature",
+      "content": "// This will be populated with the actual lazy-load-graphs.js content"
+    }
+  ]
+}

package/docs/template-playground/hbs-render.service.ts

@@ -0,0 +1,212 @@
+import { Injectable } from '@angular/core';
+
+declare const Handlebars: any;
+
+@Injectable({
+  providedIn: 'root'
+})
+export class HbsRenderService {
+  private handlebarsInstance: any;
+
+  constructor() {
+    this.initializeHandlebars();
+  }
+
+  private initializeHandlebars() {
+    // Create a new Handlebars instance for the playground
+    this.handlebarsInstance = Handlebars.create();
+
+    // Register common helpers used in Compodoc templates
+    this.registerHelpers();
+  }
+
+  private registerHelpers() {
+    // Register the 'compare' helper
+    this.handlebarsInstance.registerHelper('compare', (left: any, operator: string, right: any, options: any) => {
+      let result;
+      switch (operator) {
+        case '===':
+          result = left === right;
+          break;
+        case '!==':
+          result = left !== right;
+          break;
+        case '<':
+          result = left < right;
+          break;
+        case '>':
+          result = left > right;
+          break;
+        case '<=':
+          result = left <= right;
+          break;
+        case '>=':
+          result = left >= right;
+          break;
+        default:
+          result = false;
+      }
+      return result ? options.fn(this) : options.inverse(this);
+    });
+
+    // Register the 'unless' helper
+    this.handlebarsInstance.registerHelper('unless', (conditional: any, options: any) => {
+      return !conditional ? options.fn(this) : options.inverse(this);
+    });
+
+    // Register the 'each' helper with index
+    this.handlebarsInstance.registerHelper('each', (context: any, options: any) => {
+      let ret = '';
+      for (let i = 0; i < context.length; i++) {
+        ret += options.fn(context[i], { data: { index: i } });
+      }
+      return ret;
+    });
+
+    // Register the 'if' helper
+    this.handlebarsInstance.registerHelper('if', (conditional: any, options: any) => {
+      return conditional ? options.fn(this) : options.inverse(this);
+    });
+
+    // Register the 'relativeURL' helper
+    this.handlebarsInstance.registerHelper('relativeURL', (depth: number, page?: string) => {
+      let url = '';
+      for (let i = 0; i < depth; i++) {
+        url += '../';
+      }
+      return url + (page || '');
+    });
+
+    // Register the 't' helper for translations
+    this.handlebarsInstance.registerHelper('t', (key: string) => {
+      // Simple translation mapping for preview
+      const translations: { [key: string]: string } = {
+        'info': 'Information',
+        'source': 'Source',
+        'example': 'Example',
+        'template': 'Template',
+        'styles': 'Styles',
+        'component': 'Component',
+        'module': 'Module',
+        'overview': 'Overview',
+        'components': 'Components',
+        'modules': 'Modules',
+        'file': 'File',
+        'description': 'Description',
+        'selector': 'Selector',
+        'properties': 'Properties',
+        'methods': 'Methods',
+        'inputs': 'Inputs',
+        'outputs': 'Outputs'
+      };
+      return translations[key] || key;
+    });
+
+    // Register the 'orLength' helper
+    this.handlebarsInstance.registerHelper('orLength', (...args: any[]) => {
+      const options = args[args.length - 1];
+      const values = args.slice(0, -1);
+
+      for (const value of values) {
+        if (value && value.length && value.length > 0) {
+          return options.fn(this);
+        }
+      }
+      return options.inverse(this);
+    });
+
+    // Register the 'isTabEnabled' helper
+    this.handlebarsInstance.registerHelper('isTabEnabled', (navTabs: any[], tabId: string, options: any) => {
+      const tab = navTabs && navTabs.find((t: any) => t.id === tabId);
+      return tab ? options.fn(this) : options.inverse(this);
+    });
+
+    // Register the 'isInitialTab' helper
+    this.handlebarsInstance.registerHelper('isInitialTab', (navTabs: any[], tabId: string, options: any) => {
+      const isInitial = navTabs && navTabs.length > 0 && navTabs[0].id === tabId;
+      return isInitial ? options.fn(this) : options.inverse(this);
+    });
+  }
+
+  renderTemplate(templateContent: string, data: any): string {
+    try {
+      // Create a complete HTML document for preview
+      const template = this.handlebarsInstance.compile(templateContent);
+      const rendered = template({ data });
+
+      // Wrap in a basic HTML structure for preview
+      return `
+        <!DOCTYPE html>
+        <html>
+        <head>
+          <meta charset="utf-8">
+          <title>Template Preview</title>
+          <style>
+            body { font-family: Arial, sans-serif; margin: 20px; }
+            .preview-wrapper { border: 1px solid #ddd; padding: 20px; }
+            .preview-notice { background: #f0f8ff; padding: 10px; margin-bottom: 20px; border-left: 4px solid #007bff; }
+          </style>
+        </head>
+        <body>
+          <div class="preview-notice">
+            <strong>Template Preview:</strong> This is a live preview of your template with mock data.
+          </div>
+          <div class="preview-wrapper">
+            ${rendered}
+          </div>
+        </body>
+        </html>
+      `;
+    } catch (error) {
+      return `
+        <!DOCTYPE html>
+        <html>
+        <head>
+          <meta charset="utf-8">
+          <title>Template Preview - Error</title>
+          <style>
+            body { font-family: Arial, sans-serif; margin: 20px; }
+            .error { color: red; background: #fff5f5; padding: 20px; border: 1px solid #red; }
+          </style>
+        </head>
+        <body>
+          <div class="error">
+            <h3>Template Error</h3>
+            <p><strong>Error:</strong> ${error.message}</p>
+            <p>Please check your template syntax and try again.</p>
+          </div>
+        </body>
+        </html>
+      `;
+    }
+  }
+
+  getMockData(): any {
+    return {
+      documentationMainName: 'Sample Documentation',
+      depth: 0,
+      context: 'component',
+      components: [
+        {
+          name: 'SampleComponent',
+          selector: 'app-sample',
+          file: 'src/app/sample/sample.component.ts',
+          description: 'A sample component for demonstration',
+          properties: [
+            { name: 'title', type: 'string', description: 'The component title' },
+            { name: 'isVisible', type: 'boolean', description: 'Whether the component is visible' }
+          ],
+          methods: [
+            { name: 'ngOnInit', description: 'Lifecycle hook', signature: 'ngOnInit(): void' },
+            { name: 'onClick', description: 'Handle click events', signature: 'onClick(event: MouseEvent): void' }
+          ]
+        }
+      ],
+      navTabs: [
+        { id: 'info', label: 'Info', href: '#info' },
+        { id: 'source', label: 'Source', href: '#source' },
+        { id: 'example', label: 'Example', href: '#example' }
+      ]
+    };
+  }
+}

package/docs/template-playground/main.ts

@@ -0,0 +1,9 @@
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+import { TemplatePlaygroundModule } from './template-playground.module';
+
+// Bootstrap the Angular application when the DOM is ready
+document.addEventListener('DOMContentLoaded', () => {
+  platformBrowserDynamic()
+    .bootstrapModule(TemplatePlaygroundModule)
+    .catch(err => console.error('Error starting template playground:', err));
+});

package/docs/template-playground/template-editor.service.ts

@@ -0,0 +1,173 @@
+import { Injectable } from '@angular/core';
+
+declare const monaco: any;
+
+@Injectable({
+  providedIn: 'root'
+})
+export class TemplateEditorService {
+  private editor: any;
+  private onChangeCallback: ((value: string) => void) | null = null;
+
+  initializeEditor(container: HTMLElement) {
+    // Initialize Monaco Editor
+    this.editor = monaco.editor.create(container, {
+      value: '',
+      language: 'html',
+      theme: 'vs-dark',
+      automaticLayout: true,
+      minimap: {
+        enabled: true
+      },
+      scrollBeyondLastLine: false,
+      fontSize: 14,
+      wordWrap: 'on',
+      lineNumbers: 'on',
+      roundedSelection: false,
+      scrollbar: {
+        horizontal: 'visible',
+        vertical: 'visible'
+      },
+      overviewRulerLanes: 2,
+      quickSuggestions: {
+        other: true,
+        comments: true,
+        strings: true
+      },
+      parameterHints: {
+        enabled: true
+      },
+      autoClosingBrackets: 'always',
+      autoClosingQuotes: 'always',
+      suggestOnTriggerCharacters: true,
+      acceptSuggestionOnEnter: 'on',
+      tabCompletion: 'on',
+      wordBasedSuggestions: false
+    });
+
+    // Set up change listener
+    this.editor.onDidChangeModelContent(() => {
+      if (this.onChangeCallback) {
+        this.onChangeCallback(this.editor.getValue());
+      }
+    });
+
+    // Register custom language definitions
+    this.registerHandlebarsLanguage();
+  }
+
+  setEditorContent(content: string, fileType: string) {
+    if (this.editor) {
+      const language = this.getLanguageFromFileType(fileType);
+      const model = monaco.editor.createModel(content, language);
+      this.editor.setModel(model);
+    }
+  }
+
+  setOnChangeCallback(callback: (value: string) => void) {
+    this.onChangeCallback = callback;
+  }
+
+  private getLanguageFromFileType(fileType: string): string {
+    switch (fileType) {
+      case 'hbs':
+        return 'handlebars';
+      case 'css':
+      case 'scss':
+        return 'css';
+      case 'js':
+        return 'javascript';
+      case 'ts':
+        return 'typescript';
+      default:
+        return 'html';
+    }
+  }
+
+  private registerHandlebarsLanguage() {
+    // Register Handlebars language for Monaco Editor
+    if (monaco.languages.getLanguages().find((lang: any) => lang.id === 'handlebars')) {
+      return; // Already registered
+    }
+
+    monaco.languages.register({ id: 'handlebars' });
+
+    monaco.languages.setMonarchTokensProvider('handlebars', {
+      tokenizer: {
+        root: [
+          [/\{\{\{/, { token: 'keyword', next: '@handlebars_unescaped' }],
+          [/\{\{/, { token: 'keyword', next: '@handlebars' }],
+          [/<!DOCTYPE/, 'metatag', '@doctype'],
+          [/<!--/, 'comment', '@comment'],
+          [/(<)(\w+)/, ['delimiter', { token: 'tag', next: '@tag' }]],
+          [/(<\/)(\w+)/, ['delimiter', { token: 'tag', next: '@tag' }]],
+          [/</, 'delimiter'],
+          [/[^<]+/]
+        ],
+
+        handlebars_unescaped: [
+          [/\}\}\}/, { token: 'keyword', next: '@pop' }],
+          [/[^}]+/, 'variable']
+        ],
+
+        handlebars: [
+          [/\}\}/, { token: 'keyword', next: '@pop' }],
+          [/#if|#unless|#each|#with|\/if|\/unless|\/each|\/with/, 'keyword'],
+          [/[a-zA-Z_][\w]*/, 'variable'],
+          [/[^}]+/, 'variable']
+        ],
+
+        comment: [
+          [/-->/, 'comment', '@pop'],
+          [/[^-]+/, 'comment'],
+          [/./, 'comment']
+        ],
+
+        doctype: [
+          [/[^>]+/, 'metatag.content'],
+          [/>/, 'metatag', '@pop']
+        ],
+
+        tag: [
+          [/[ \t\r\n]+/, 'white'],
+          [/(\w+)(\s*=\s*)("([^"]*)")/, ['attribute.name', 'delimiter', 'attribute.value', 'attribute.value']],
+          [/(\w+)(\s*=\s*)('([^']*)')/, ['attribute.name', 'delimiter', 'attribute.value', 'attribute.value']],
+          [/\w+/, 'attribute.name'],
+          [/>/, 'delimiter', '@pop']
+        ]
+      }
+    });
+
+    monaco.languages.setLanguageConfiguration('handlebars', {
+      comments: {
+        blockComment: ['<!--', '-->']
+      },
+      brackets: [
+        ['<', '>'],
+        ['{{', '}}'],
+        ['{{{', '}}}']
+      ],
+      autoClosingPairs: [
+        { open: '<', close: '>' },
+        { open: '{{', close: '}}' },
+        { open: '{{{', close: '}}}' },
+        { open: '"', close: '"' },
+        { open: "'", close: "'" }
+      ],
+      surroundingPairs: [
+        { open: '<', close: '>' },
+        { open: '{{', close: '}}' },
+        { open: '{{{', close: '}}}' },
+        { open: '"', close: '"' },
+        { open: "'", close: "'" }
+      ]
+    });
+  }
+
+  destroy() {
+    if (this.editor) {
+      this.editor.dispose();
+      this.editor = null;
+    }
+  }
+}