mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
2d8635d29d
To increase the ease of development we are moving @angular/docs into the adev directory within this repo. While we are doing this to improve our development experience in the short term, efforts are also in place to maintain a division between this @angular/docs (shared) code and adev itself, so that it can be extracted back out in the future when components is ready to leverage it as well. PR Close #57132
40 lines
1.2 KiB
TypeScript
40 lines
1.2 KiB
TypeScript
/*!
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.dev/license
|
|
*/
|
|
|
|
import {Type} from '@angular/core';
|
|
|
|
/**
|
|
* Map of the examples, values are functions which returns the promise of the component type, which will be displayed as preview in the ExampleViewer component
|
|
*/
|
|
export interface CodeExamplesMap {
|
|
[id: string]: () => Promise<Type<unknown>>;
|
|
}
|
|
|
|
export interface Snippet {
|
|
/** Title of the code snippet */
|
|
title?: string;
|
|
/** Name of the file. */
|
|
name: string;
|
|
/** Content of code snippet */
|
|
content: string;
|
|
/** Text in following format `start-end`. Start and end are numbers, based on them provided range of lines will be displayed in collapsed mode */
|
|
visibleLinesRange?: string;
|
|
}
|
|
|
|
export interface ExampleMetadata {
|
|
/** Numeric id of example, used to generate unique link to the example */
|
|
id: number;
|
|
/** Title of the example. */
|
|
title?: string;
|
|
/** Path to the preview component */
|
|
path?: string;
|
|
/** List of files which are part of the example. */
|
|
files: Snippet[];
|
|
/** True when ExampleViewer should have preview */
|
|
preview: boolean;
|
|
}
|