@skyux/icon 10.36.0 → 10.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/documentation.json +107 -11
  2. package/package.json +3 -3
package/documentation.json CHANGED
@@ -32,7 +32,7 @@
32
32
  "fileName": "projects/icon/src/icon/icon.module.ts",
33
33
  "line": 14,
34
34
  "character": 13,
35
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/icon.module.ts#L14"
35
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/icon.module.ts#L14"
36
36
  }
37
37
  ],
38
38
  "decorators": [
@@ -83,7 +83,7 @@
83
83
  "fileName": "projects/icon/src/icon/icon.component.ts",
84
84
  "line": 59,
85
85
  "character": 9,
86
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/icon.component.ts#L59"
86
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/icon.component.ts#L59"
87
87
  }
88
88
  ],
89
89
  "type": {
@@ -131,7 +131,7 @@
131
131
  "fileName": "projects/icon/src/icon/icon.component.ts",
132
132
  "line": 26,
133
133
  "character": 9,
134
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/icon.component.ts#L26"
134
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/icon.component.ts#L26"
135
135
  }
136
136
  ],
137
137
  "type": {
@@ -201,7 +201,7 @@
201
201
  "fileName": "projects/icon/src/icon/icon.component.ts",
202
202
  "line": 43,
203
203
  "character": 9,
204
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/icon.component.ts#L43"
204
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/icon.component.ts#L43"
205
205
  }
206
206
  ],
207
207
  "type": {
@@ -245,7 +245,7 @@
245
245
  "fileName": "projects/icon/src/icon/icon.component.ts",
246
246
  "line": 50,
247
247
  "character": 9,
248
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/icon.component.ts#L50"
248
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/icon.component.ts#L50"
249
249
  }
250
250
  ],
251
251
  "type": {
@@ -279,7 +279,7 @@
279
279
  "fileName": "projects/icon/src/icon/icon.component.ts",
280
280
  "line": 66,
281
281
  "character": 9,
282
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/icon.component.ts#L66"
282
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/icon.component.ts#L66"
283
283
  }
284
284
  ],
285
285
  "type": {
@@ -318,7 +318,7 @@
318
318
  "fileName": "projects/icon/src/icon/icon.component.ts",
319
319
  "line": 18,
320
320
  "character": 13,
321
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/icon.component.ts#L18"
321
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/icon.component.ts#L18"
322
322
  }
323
323
  ],
324
324
  "decorators": [
@@ -350,7 +350,7 @@
350
350
  "fileName": "projects/icon/src/icon/types/icon-type.ts",
351
351
  "line": 4,
352
352
  "character": 12,
353
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/types/icon-type.ts#L4"
353
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/types/icon-type.ts#L4"
354
354
  }
355
355
  ],
356
356
  "type": {
@@ -378,7 +378,7 @@
378
378
  "fileName": "projects/icon/src/icon/types/icon-variant-type.ts",
379
379
  "line": 1,
380
380
  "character": 12,
381
- "url": "https://github.com/blackbaud/skyux/blob/b0496dc/libs/components/icon/src/lib/icon/types/icon-variant-type.ts#L1"
381
+ "url": "https://github.com/blackbaud/skyux/blob/03e4f54/libs/components/icon/src/lib/icon/types/icon-variant-type.ts#L1"
382
382
  }
383
383
  ],
384
384
  "type": {
@@ -462,6 +462,102 @@
462
462
  }
463
463
  }
464
464
  },
465
- "codeExamples": [],
466
- "codeExampleDependencies": {}
465
+ "codeExamples": [
466
+ {
467
+ "fileName": "demo.component.ts",
468
+ "filePath": "/projects/icon/documentation/code-examples/icon-button/demo.component.ts",
469
+ "rawContents": "import { Component } from '@angular/core';\nimport { SkyIconModule } from '@skyux/indicators';\n\n@Component({\n standalone: true,\n selector: 'app-demo',\n templateUrl: './demo.component.html',\n imports: [SkyIconModule],\n})\nexport class DemoComponent {\n protected textButtonClick(): void {\n alert('Text with icon button clicked');\n }\n\n protected iconOnlyButtonClick(): void {\n alert('Icon only button clicked');\n }\n}\n"
470
+ },
471
+ {
472
+ "fileName": "demo.component.spec.ts",
473
+ "filePath": "/projects/icon/documentation/code-examples/icon-button/demo.component.spec.ts",
474
+ "rawContents": "import { TestbedHarnessEnvironment } from '@angular/cdk/testing/testbed';\nimport { ComponentFixture, TestBed } from '@angular/core/testing';\nimport { SkyIconHarness } from '@skyux/indicators/testing';\n\nimport { DemoComponent } from './demo.component';\n\ndescribe('Icon button', () => {\n async function setupTest(options: { dataSkyId?: string }): Promise<{\n iconHarness: SkyIconHarness;\n fixture: ComponentFixture<DemoComponent>;\n }> {\n const fixture = TestBed.createComponent(DemoComponent);\n const loader = TestbedHarnessEnvironment.loader(fixture);\n const iconHarness = await loader.getHarness(\n SkyIconHarness.with({\n dataSkyId: options?.dataSkyId,\n }),\n );\n\n return { iconHarness, fixture };\n }\n\n beforeEach(() => {\n TestBed.configureTestingModule({\n imports: [DemoComponent],\n });\n });\n\n it('should display the icon in the text icon button', async () => {\n const { iconHarness, fixture } = await setupTest({\n dataSkyId: 'text-button-icon',\n });\n\n fixture.detectChanges();\n\n await expectAsync(iconHarness.getIconName()).toBeResolvedTo('save');\n });\n\n it('should display the icon in the icon only button', async () => {\n const { iconHarness, fixture } = await setupTest({\n dataSkyId: 'button-icon',\n });\n\n fixture.detectChanges();\n\n await expectAsync(iconHarness.getIconName()).toBeResolvedTo('edit');\n });\n});\n"
475
+ },
476
+ {
477
+ "fileName": "demo.component.html",
478
+ "filePath": "/projects/icon/documentation/code-examples/icon-button/demo.component.html",
479
+ "rawContents": "<button\n class=\"sky-btn sky-btn-default\"\n type=\"button\"\n (click)=\"textButtonClick()\"\n>\n Save\n <sky-icon data-sky-id=\"text-button-icon\" icon=\"save\" />\n</button>\n\n<button\n class=\"sky-btn sky-btn-icon-borderless\"\n type=\"button\"\n (click)=\"iconOnlyButtonClick()\"\n>\n <sky-icon data-sky-id=\"button-icon\" icon=\"edit\" size=\"lg\" />\n</button>\n"
480
+ },
481
+ {
482
+ "fileName": "demo.component.ts",
483
+ "filePath": "/projects/icon/documentation/code-examples/basic/demo.component.ts",
484
+ "rawContents": "import { Component } from '@angular/core';\nimport { SkyIconModule } from '@skyux/indicators';\n\n@Component({\n standalone: true,\n selector: 'app-demo',\n templateUrl: './demo.component.html',\n imports: [SkyIconModule],\n})\nexport class DemoComponent {}\n"
485
+ },
486
+ {
487
+ "fileName": "demo.component.spec.ts",
488
+ "filePath": "/projects/icon/documentation/code-examples/basic/demo.component.spec.ts",
489
+ "rawContents": "import { TestbedHarnessEnvironment } from '@angular/cdk/testing/testbed';\nimport { ComponentFixture, TestBed } from '@angular/core/testing';\nimport { SkyIconHarness } from '@skyux/indicators/testing';\n\nimport { DemoComponent } from './demo.component';\n\ndescribe('Basic icon', () => {\n async function setupTest(): Promise<{\n iconHarness: SkyIconHarness;\n fixture: ComponentFixture<DemoComponent>;\n }> {\n const fixture = TestBed.createComponent(DemoComponent);\n const loader = TestbedHarnessEnvironment.loader(fixture);\n const iconHarness = await loader.getHarness(\n SkyIconHarness.with({\n dataSkyId: 'icon-demo',\n }),\n );\n\n return { iconHarness, fixture };\n }\n\n beforeEach(() => {\n TestBed.configureTestingModule({\n imports: [DemoComponent],\n });\n });\n\n it('should display the correct icon', async () => {\n const { iconHarness, fixture } = await setupTest();\n\n fixture.detectChanges();\n\n await expectAsync(iconHarness.getIconName()).toBeResolvedTo('calendar');\n await expectAsync(iconHarness.getVariant()).toBeRejectedWithError(\n 'Variant cannot be determined because variants are only assigned to icons with type `skyux`.',\n );\n await expectAsync(iconHarness.getIconSize()).toBeResolvedTo('4x');\n await expectAsync(iconHarness.isFixedWidth()).toBeResolvedTo(true);\n });\n});\n"
490
+ },
491
+ {
492
+ "fileName": "demo.component.html",
493
+ "filePath": "/projects/icon/documentation/code-examples/basic/demo.component.html",
494
+ "rawContents": "<sky-icon icon=\"calendar\" />\n<sky-icon icon=\"calendar\" size=\"lg\" />\n<sky-icon icon=\"calendar\" size=\"2x\" />\n<sky-icon icon=\"calendar\" variant=\"line\" size=\"3x\" />\n<sky-icon\n data-sky-id=\"icon-demo\"\n icon=\"calendar\"\n variant=\"solid\"\n size=\"4x\"\n [fixedWidth]=\"true\"\n/>\n\n<div>\n <sky-icon icon=\"bars\" size=\"2x\" />\n</div>\n\n<div>\n <sky-icon icon=\"chevron-down\" size=\"2x\" />\n</div>\n\n<div>\n <sky-icon icon=\"bars\" size=\"2x\" [fixedWidth]=\"true\" />\n</div>\n\n<div>\n <sky-icon icon=\"chevron-down\" size=\"2x\" [fixedWidth]=\"true\" />\n</div>\n"
495
+ }
496
+ ],
497
+ "codeExampleDependencies": {
498
+ "/projects/icon/documentation/code-examples/icon-button": {
499
+ "@angular-devkit/core": "17.3.4",
500
+ "@angular-devkit/schematics": "17.3.4",
501
+ "@angular/animations": "17.3.4",
502
+ "@angular/cdk": "17.3.4",
503
+ "@angular/cli": "17.3.4",
504
+ "@angular/common": "17.3.4",
505
+ "@angular/core": "17.3.4",
506
+ "@angular/forms": "17.3.4",
507
+ "@angular/platform-browser": "17.3.4",
508
+ "@angular/router": "17.3.4",
509
+ "@blackbaud/skyux-design-tokens": "0.0.28",
510
+ "@schematics/angular": "17.3.2",
511
+ "@skyux-sdk/testing": "10.37.0",
512
+ "@skyux/assets": "10.37.0",
513
+ "@skyux/core": "10.37.0",
514
+ "@skyux/help-inline": "10.37.0",
515
+ "@skyux/i18n": "10.37.0",
516
+ "@skyux/icon": "10.37.0",
517
+ "@skyux/icons": "7.3.0",
518
+ "@skyux/indicators": "10.37.0",
519
+ "@skyux/popovers": "10.37.0",
520
+ "@skyux/theme": "10.37.0",
521
+ "axe-core": "4.9.0",
522
+ "cross-spawn": "7.0.3",
523
+ "fontfaceobserver": "2.3.0",
524
+ "glob": "10.3.10",
525
+ "jsonc-parser": "3.2.1",
526
+ "rxjs": "7.8.1",
527
+ "tslib": "2.6.2",
528
+ "zone.js": "0.14.4"
529
+ },
530
+ "/projects/icon/documentation/code-examples/basic": {
531
+ "@angular-devkit/core": "17.3.4",
532
+ "@angular-devkit/schematics": "17.3.4",
533
+ "@angular/animations": "17.3.4",
534
+ "@angular/cdk": "17.3.4",
535
+ "@angular/cli": "17.3.4",
536
+ "@angular/common": "17.3.4",
537
+ "@angular/core": "17.3.4",
538
+ "@angular/forms": "17.3.4",
539
+ "@angular/platform-browser": "17.3.4",
540
+ "@angular/router": "17.3.4",
541
+ "@blackbaud/skyux-design-tokens": "0.0.28",
542
+ "@schematics/angular": "17.3.2",
543
+ "@skyux-sdk/testing": "10.37.0",
544
+ "@skyux/assets": "10.37.0",
545
+ "@skyux/core": "10.37.0",
546
+ "@skyux/help-inline": "10.37.0",
547
+ "@skyux/i18n": "10.37.0",
548
+ "@skyux/icon": "10.37.0",
549
+ "@skyux/icons": "7.3.0",
550
+ "@skyux/indicators": "10.37.0",
551
+ "@skyux/popovers": "10.37.0",
552
+ "@skyux/theme": "10.37.0",
553
+ "axe-core": "4.9.0",
554
+ "cross-spawn": "7.0.3",
555
+ "fontfaceobserver": "2.3.0",
556
+ "glob": "10.3.10",
557
+ "jsonc-parser": "3.2.1",
558
+ "rxjs": "7.8.1",
559
+ "tslib": "2.6.2",
560
+ "zone.js": "0.14.4"
561
+ }
562
+ }
467
563
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/icon",
3
- "version": "10.36.0",
3
+ "version": "10.37.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -39,8 +39,8 @@
39
39
  "@angular/cdk": "^17.3.4",
40
40
  "@angular/common": "^17.3.4",
41
41
  "@angular/core": "^17.3.4",
42
- "@skyux/core": "10.36.0",
43
- "@skyux/theme": "10.36.0"
42
+ "@skyux/core": "10.37.0",
43
+ "@skyux/theme": "10.37.0"
44
44
  },
45
45
  "dependencies": {
46
46
  "tslib": "^2.6.2"