{"id":18419756,"url":"https://github.com/teradata/covalent-markdown-navigator-nightly","last_synced_at":"2025-04-13T09:14:30.487Z","repository":{"id":146377620,"uuid":"105178200","full_name":"Teradata/covalent-markdown-navigator-nightly","owner":"Teradata","description":"Nightly builds of https://github.com/teradata/covalent markdown-navigator module","archived":false,"fork":false,"pushed_at":"2021-04-07T19:26:06.000Z","size":1851,"stargazers_count":5,"open_issues_count":5,"forks_count":4,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-13T09:14:25.662Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Teradata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-28T17:24:18.000Z","updated_at":"2021-04-07T19:26:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"685d9fad-bd59-4a28-a943-057659f53dfd","html_url":"https://github.com/Teradata/covalent-markdown-navigator-nightly","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teradata%2Fcovalent-markdown-navigator-nightly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teradata%2Fcovalent-markdown-navigator-nightly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teradata%2Fcovalent-markdown-navigator-nightly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teradata%2Fcovalent-markdown-navigator-nightly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Teradata","download_url":"https://codeload.github.com/Teradata/covalent-markdown-navigator-nightly/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248688550,"owners_count":21145766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T04:18:16.754Z","updated_at":"2025-04-13T09:14:30.461Z","avatar_url":"https://github.com/Teradata.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MarkdownNavigatorComponent\n\nA component for rendering and navigating through markdown, such as documentation. Supports github urls.\n\n## API Summary\n\n#### Inputs\n\n+ items: IMarkdownNavigatorItem[]\n  + List of IMarkdownNavigatorItems to be rendered\n+ labels?: IMarkdownNavigatorLabels\n  + Translated labels\n+ startAt?: IMarkdownNavigatorItem | IMarkdownNavigatorItem[]\n  + Item or path to jump to\n+ compareWith?: IMarkdownNavigatorCompareWith\n  + Function used to find startAt item\n  + Defaults to comparison by strict equality (===)\n+ footer:? Type\u003cany\u003e\n  + Custom component to be used as global footer\n+ copyCodeToClipboard?: boolean\n  + Display copy button on code snippets to copy code to clipboard.\n+ copyCodeTooltips?: ICopyCodeTooltips\n  + Tooltips for copy button to copy and upon copying.\n\n#### Outputs\n\n+ buttonClicked: ITdFlavoredMarkdownButtonClickEvent\n  + Emitted when a button is clicked\n\nFor reference:\n\n```typescript\ninterface IMarkdownNavigatorItem {\n  id?: string; // used to compare items by default and as attr id for content\n  title?: string;\n  url?: string;\n  httpOptions?: object;\n  markdownString?: string; // raw markdown\n  anchor?: string;\n  children?: IMarkdownNavigatorItem[];\n  childrenUrl?: string;\n  description?: string;\n  icon?: string;\n  footer?: Type\u003cany\u003e;\n}\n\ninterface ICopyCodeTooltips {\n  copy?: string;\n  copied?: string;\n}\n```\n\n## Setup\n\n```typescript\nimport { CovalentMarkdownNavigatorModule } from '@covalent/markdown-navigator';\n@NgModule({\n  imports: [CovalentMarkdownNavigatorModule]\n})\nexport class MyModule {}\n```\n\n## Usage\n\n```html\n\u003ctd-markdown-navigator [items]=\"items\"\u003e\u003c/td-markdown-navigator\u003e\n```\n\n```typescript\nconst items = [\n  {\n    id: 'covalent',\n    title: 'Covalent',\n    children: [\n      {\n        id: 'component',\n        title: 'Components',\n        children: [\n          {\n            id: 'td-loading',\n            url: 'https://raw.githubusercontent.com/Teradata/covalent/develop/src/platform/core/loading/README.md',\n            title: 'tdLoading'\n          }\n        ]\n      }\n    ]\n  }\n];\n```\n\n# MarkdownNavigatorWindowComponent\n\nA component that contains a MarkdownNavigator component and a toolbar\n\n## API Summary\n\n#### Inputs\n\n+ items: IMarkdownNavigatorItem[]\n  + List of IMarkdownNavigatorItems to be rendered\n+ labels?: IMarkdownNavigatorLabels\n  + Translated labels\n+ startAt?: IMarkdownNavigatorItem | IMarkdownNavigatorItem[]\n  + Item or path to jump to\n+ compareWith?: IMarkdownNavigatorCompareWith\n  + Function used to find startAt item\n  + Defaults to comparison by strict equality (===)\n+ toolbarColor?: ThemePalette\n  + Toolbar color\n  + Defaults to 'primary'\n+ footer:? Type\u003cany\u003e;\n  + Custom component to be used as global footer\n\n\n#### Outputs\n\n+ closed: void\n  + Event emitted when the close button is clicked.\n+ buttonClicked: ITdFlavoredMarkdownButtonClickEvent\n  + Emitted when a button is clicked\n\n## Setup\n\n```typescript\nimport { CovalentMarkdownNavigatorModule } from '@covalent/markdown-navigator';\n@NgModule({\n  imports: [CovalentMarkdownNavigatorModule]\n})\nexport class MyModule {}\n```\n\n## Usage\n\n```html\n\u003ctd-markdown-navigator-window [items]=\"items\"\u003e\u003c/td-markdown-navigator-window\u003e\n```\n\n# MarkdownNavigatorWindowService\n\nA service that opens a MarkdownNavigatorWindowComponent inside a draggable dialog. Uses the openDraggable method of the TdDialogService.\n\n## API Summary\n\n#### Methods\n\n+ open: function(config: IMarkdownNavigatorWindowConfig)\n  + Opens a MarkdownNavigatorWindowComponent inside a draggable dialog.\n\nFor reference:\n\n```typescript\ninterface IMarkdownNavigatorWindowConfig {\n  items: IMarkdownNavigatorItem[];\n  dialogConfig?: MatDialogConfig;\n  labels?: IMarkdownNavigatorWindowLabels;\n  toolbarColor?: ThemePalette;\n  startAt?: IMarkdownNavigatorItem | IMarkdownNavigatorItem[];\n  compareWith?: IMarkdownNavigatorCompareWith;\n  footer?: Type\u003cany\u003e;\n}\n```\n\n## Setup\n\n```typescript\nimport { CovalentMarkdownNavigatorModule } from '@covalent/markdown-navigator';\n@NgModule({\n  imports: [CovalentMarkdownNavigatorModule]\n})\nexport class MyModule {}\n```\n\n## Usage\n\n```typescript\nimport {\n  TdMarkdownNavigatorWindowComponent,\n  TdMarkdownNavigatorWindowService,\n  IMarkdownNavigatorItem\n} from '@covalent/markdown-navigator';\nimport { MatDialogRef } from '@angular/material/dialog';\n\nexport class SampleComponent {\n  constructor(private _markdownNavigatorWindowService: TdMarkdownNavigatorWindowService) {}\n\n  ngOnInit(): void {\n    const ref: MatDialogRef\u003cTdMarkdownNavigatorWindowComponent\u003e = this._markdownNavigatorWindowService.open({\n      items: [{ url: 'https://github.com/Teradata/covalent/blob/develop/README.md' }]\n    });\n    ref.afterOpened().subscribe(() =\u003e {});\n    ref.afterClosed().subscribe(() =\u003e {});\n  }\n}\n```\n\n# MarkdownNavigatorWindowDirective\n\nA directive that calls the TdMarkdownNavigatorWindowService open method on click events.\n\n## API Summary\n\n#### Inputs\n\n+ tdMarkdownNavigatorWindow: IMarkdownNavigatorWindowConfig\n  + Config to open window with\n+ disabled: boolean\n  + Whether disabled or not\n\n## Setup\n\n```typescript\nimport { CovalentMarkdownNavigatorModule } from '@covalent/markdown-navigator';\n@NgModule({\n  imports: [CovalentMarkdownNavigatorModule]\n})\nexport class MyModule {}\n```\n\n## Usage\n\nExample:\n\n```html\n\u003cbutton mat-button [tdMarkdownNavigatorWindow]=\"{ items: [] }\" [disabled]=\"false\"\u003eOpen window\u003c/button\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteradata%2Fcovalent-markdown-navigator-nightly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteradata%2Fcovalent-markdown-navigator-nightly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteradata%2Fcovalent-markdown-navigator-nightly/lists"}