Skip to content
This repository was archived by the owner on Dec 18, 2024. It is now read-only.

Commit a229178

Browse files
mmalerbawagnermaciel
mmalerba
authored and
wagnermaciel
committed
docs(material/core): Add core API docs
1 parent 60516eb commit a229178

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+69
-29
lines changed

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"@angular/cdk-experimental": "^12.0.1",
4141
"@angular/common": "^12.0.0",
4242
"@angular/compiler": "^12.0.0",
43-
"@angular/components-examples": "angular/material2-docs-content#12.0.x",
43+
"@angular/components-examples": "angular/material2-docs-content#master",
4444
"@angular/core": "^12.0.0",
4545
"@angular/forms": "^12.0.0",
4646
"@angular/google-maps": "^12.0.1",

‎scenes/e2e/src/app.e2e-spec.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ describe('screenshot scenes for each component', () => {
1515
'card',
1616
'checkbox',
1717
'chips',
18+
'core',
1819
'datepicker',
1920
'dialog',
2021
'divider',

‎scenes/src/app/app-routing.module.ts

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,43 @@
1+
import {ComponentType} from '@angular/cdk/overlay';
12
import {NgModule} from '@angular/core';
23
import {RouterModule} from '@angular/router';
34
import {SceneViewer} from './scene-viewer/scene-viewer';
5+
import {AutocompleteScene} from './scenes/autocomplete/autocomplete-scene';
6+
import {BadgeScene} from './scenes/badge/badge-scene';
47
import {BottomSheetScene} from './scenes/bottom-sheet/bottom-sheet-scene';
5-
import {GridListScene} from './scenes/grid-list/grid-list-scene';
6-
import {RipplesScene} from './scenes/ripples/ripples-scene';
7-
import {InputScene} from './scenes/input/input-scene';
88
import {ButtonToggleScene} from './scenes/button-toggle/button-toggle-scene';
9-
import {SliderScene} from './scenes/slider/slider-scene';
10-
import {SlideToggleScene} from './scenes/slide-toggle/slide-toggle-scene';
11-
import {DividerScene} from './scenes/divider/divider-scene';
12-
import {ComponentType} from '@angular/cdk/overlay';
13-
import {ProgressSpinnerScene} from './scenes/progress-spinner/progress-spinner-scene';
149
import {ButtonScene} from './scenes/button/button-scene';
15-
import {DatepickerScene} from './scenes/datepicker/datepicker-scene';
10+
import {CardScene} from './scenes/card/card-scene';
1611
import {CheckboxScene} from './scenes/checkbox/checkbox-scene';
1712
import {ChipsScene} from './scenes/chips/chips-scene';
13+
import {CoreScene} from './scenes/core/core-scene';
14+
import {DatepickerScene} from './scenes/datepicker/datepicker-scene';
15+
import {DialogScene} from './scenes/dialog/dialog-scene';
16+
import {DividerScene} from './scenes/divider/divider-scene';
17+
import {ExpansionScene} from './scenes/expansion/expansion-scene';
18+
import {FormFieldScene} from './scenes/form-field/form-field-scene';
19+
import {GridListScene} from './scenes/grid-list/grid-list-scene';
20+
import {IconScene} from './scenes/icon/icon-scene';
21+
import {InputScene} from './scenes/input/input-scene';
22+
import {ListScene} from './scenes/list/list-scene';
23+
import {MenuScene} from './scenes/menu/menu-scene';
24+
import {PaginatorScene} from './scenes/paginator/paginator-scene';
1825
import {ProgressBarScene} from './scenes/progress-bar/progress-bar-scene';
26+
import {ProgressSpinnerScene} from './scenes/progress-spinner/progress-spinner-scene';
27+
import {RadioScene} from './scenes/radio/radio-scene';
28+
import {RipplesScene} from './scenes/ripples/ripples-scene';
29+
import {SelectScene} from './scenes/select/select-scene';
30+
import {SidenavScene} from './scenes/sidenav/sidenav-scene';
31+
import {SlideToggleScene} from './scenes/slide-toggle/slide-toggle-scene';
32+
import {SliderScene} from './scenes/slider/slider-scene';
1933
import {SnackBarScene} from './scenes/snack-bar/snack-bar-scene';
34+
import {SortScene} from './scenes/sort/sort-scene';
2035
import {StepperScene} from './scenes/stepper/stepper-scene';
21-
import {RadioScene} from './scenes/radio/radio-scene';
22-
import {MenuScene} from './scenes/menu/menu-scene';
23-
import {BadgeScene} from './scenes/badge/badge-scene';
24-
import {PaginatorScene} from './scenes/paginator/paginator-scene';
2536
import {TableScene} from './scenes/table/table-scene';
26-
import {SortScene} from './scenes/sort/sort-scene';
2737
import {TabsScene} from './scenes/tabs/tabs-scene';
28-
import {ExpansionScene} from './scenes/expansion/expansion-scene';
29-
import {SelectScene} from './scenes/select/select-scene';
30-
import {AutocompleteScene} from './scenes/autocomplete/autocomplete-scene';
31-
import {TreeScene} from './scenes/tree/tree-scene';
32-
import {CardScene} from './scenes/card/card-scene';
33-
import {ListScene} from './scenes/list/list-scene';
34-
import {TooltipScene} from './scenes/tooltip/tooltip-scene';
35-
import {DialogScene} from './scenes/dialog/dialog-scene';
36-
import {FormFieldScene} from './scenes/form-field/form-field-scene';
3738
import {ToolbarScene} from './scenes/toolbar/toolbar-scene';
38-
import {SidenavScene} from './scenes/sidenav/sidenav-scene';
39-
import {IconScene} from './scenes/icon/icon-scene';
39+
import {TooltipScene} from './scenes/tooltip/tooltip-scene';
40+
import {TreeScene} from './scenes/tree/tree-scene';
4041

4142
let hue = 0;
4243

@@ -59,6 +60,7 @@ const routes: SceneViewerRoute[] = [
5960
{path: 'card', component: SceneViewer, data: {scene: CardScene}},
6061
{path: 'checkbox', component: SceneViewer, data: {scene: CheckboxScene}},
6162
{path: 'chips', component: SceneViewer, data: {scene: ChipsScene}},
63+
{path: 'core', component: SceneViewer, data: {scene: CoreScene}},
6264
{path: 'datepicker', component: SceneViewer, data: {scale: 0.8, scene: DatepickerScene}},
6365
{path: 'dialog', component: SceneViewer, data: {scene: DialogScene}},
6466
{path: 'divider', component: SceneViewer, data: {scale: 2, scene: DividerScene}},

‎scenes/src/app/scenes/core/core-scene.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<div class="core-icon">
2+
<mat-icon>settings</mat-icon>
3+
</div>

‎scenes/src/app/scenes/core/core-scene.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.core-icon {
2+
display: flex;
3+
transform: scale(3);
4+
}

‎scenes/src/app/scenes/core/core-scene.ts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import {Component, NgModule, ViewEncapsulation} from '@angular/core';
2+
import {MatIconModule} from '@angular/material/icon';
3+
4+
@Component({
5+
encapsulation: ViewEncapsulation.None,
6+
selector: 'app-core-scene',
7+
templateUrl: './core-scene.html',
8+
styleUrls: ['./core-scene.scss']
9+
})
10+
export class CoreScene {
11+
}
12+
13+
@NgModule({
14+
imports: [
15+
MatIconModule
16+
],
17+
exports: [CoreScene],
18+
declarations: [CoreScene]
19+
})
20+
export class ChipsSceneModule {}
21+

‎src/app/shared/documentation-items/documentation-items.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,15 @@ const DOCS: { [key: string]: DocItem[] } = {
372372
prefix: 'tree-',
373373
},
374374
},
375+
{
376+
id: 'core',
377+
name: 'Core',
378+
summary: 'Reusable parts used by other components in the library.',
379+
exampleSpecs: {
380+
prefix: 'core-',
381+
},
382+
additionalApiDocs: [{name: 'Testing', path: 'material-core-testing.html'}],
383+
},
375384
],
376385
[CDK]: [
377386
{

‎src/assets/screenshots/autocomplete.scene.png

-204 Bytes

‎src/assets/screenshots/badge.scene.png

-38 Bytes

‎src/assets/screenshots/bottom-sheet.scene.png

-107 Bytes

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy