Summary list component #706
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import { PrimitiveValue } from '@hypertrace/common'; | ||
|
|
||
| export interface SummaryItem { | ||
| label: string; | ||
| value: PrimitiveValue | PrimitiveValue[]; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| @import 'mixins'; | ||
|
|
||
| .summary-list { | ||
| padding: 16px; | ||
|
|
||
| .summary-header { | ||
| display: flex; | ||
| align-items: center; | ||
| padding-top: 4px; | ||
| padding-bottom: 16px; | ||
| border-bottom: 1px solid $gray-2; | ||
|
|
||
| .summary-icon { | ||
| color: $gray-7; | ||
| padding-right: 8px; | ||
| } | ||
|
|
||
| .summary-title { | ||
| @include body-2-medium($gray-7); | ||
| } | ||
| } | ||
|
|
||
| .summary-value-title { | ||
| @include body-2-medium($gray-7); | ||
| display: block; | ||
| padding-top: 16px; | ||
| } | ||
|
|
||
| .summary-value-list { | ||
| list-style-type: none; | ||
| margin: 0; | ||
| padding: 0; | ||
|
|
||
| .summary-value { | ||
| @include body-2-regular($gray-7); | ||
| padding-top: 3px; | ||
|
|
||
| &:first-child { | ||
| padding-top: 6px; | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| import { IconType } from '@hypertrace/assets-library'; | ||
| import { IconComponent, LabelComponent, SummaryListComponent } from '@hypertrace/components'; | ||
| import { createHostFactory, SpectatorHost } from '@ngneat/spectator/jest'; | ||
| import { MockComponent } from 'ng-mocks'; | ||
|
|
||
| describe('Summary List component', () => { | ||
| let spectator: SpectatorHost<SummaryListComponent>; | ||
|
|
||
| const createHost = createHostFactory({ | ||
| component: SummaryListComponent, | ||
|
Contributor
There was a problem hiding this comment. For a component with inputs and ouputs, using a hostfactory allows you to provide inputs and then verify it rendered correctly. This test only verifies the logic directly rather than for a given set of inputs it renders the html we want - that's what we're generally looking for in a component's tests - the functions are implementation details. |
||
| shallow: true, | ||
| declarations: [MockComponent(IconComponent), MockComponent(LabelComponent)] | ||
| }); | ||
|
|
||
| beforeEach(() => { | ||
| spectator = createHost( | ||
| ` | ||
| <ht-summary-list | ||
| [title]="title" | ||
| [icon]="icon" | ||
| [items]="items" | ||
| ></ht-summary-list>`, | ||
| { | ||
| hostProps: { | ||
| title: 'My Title', | ||
| icon: IconType.Add, | ||
| items: [ | ||
| { | ||
| label: 'number', | ||
| value: 0 | ||
| }, | ||
| { | ||
| label: 'Number-Array', | ||
| value: [0, 1, 2] | ||
| }, | ||
| { | ||
| label: 'STRING', | ||
| value: 'zero' | ||
| }, | ||
| { | ||
| label: 'STRING_ARRAY', | ||
| value: ['zero', 'one', 'two', 'three'] | ||
| }, | ||
| { | ||
| label: 'bOOleAN', | ||
| value: true | ||
| }, | ||
| { | ||
| label: 'boolean-array', | ||
| value: [true, false] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ); | ||
| }); | ||
|
|
||
| test('sets title and icon', () => { | ||
| expect(spectator.query('.summary-icon', { read: IconComponent })?.icon).toEqual(IconType.Add); | ||
| expect(spectator.query('.summary-title', { read: LabelComponent })?.label).toEqual('My Title'); | ||
| }); | ||
|
|
||
| test('formats label', () => { | ||
| const labelComponents = spectator.queryAll('.summary-value-title', { read: LabelComponent }); | ||
| expect(labelComponents.map(c => c.label)).toEqual([ | ||
| 'Number', | ||
| 'Number Array', | ||
| 'String', | ||
| 'String Array', | ||
| 'Boolean', | ||
| 'Boolean Array' | ||
| ]); | ||
| }); | ||
|
|
||
| test('gets value array', () => { | ||
| const values = spectator.queryAll('li').map(e => e.textContent); | ||
| expect(values).toEqual(['0', '0', '1', '2', 'zero', 'zero', 'one', 'two', 'three', 'true', 'true', 'false']); | ||
|
Contributor
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment. It was worth updating this test just to see that video. |
||
| }); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import { ChangeDetectionStrategy, Component, Input } from '@angular/core'; | ||
| import { IconType } from '@hypertrace/assets-library'; | ||
| import { PrimitiveValue } from '@hypertrace/common'; | ||
| import { startCase } from 'lodash-es'; | ||
| import { SummaryItem } from './summary-list-api'; | ||
|
|
||
| @Component({ | ||
| selector: 'ht-summary-list', | ||
|
Contributor
There was a problem hiding this comment. I don't love the name (when do I ever?). We already have a list-view, card-list, summary-values, table - so from the names, it's not clear how this one is different and when to use which.
Contributor
Author
There was a problem hiding this comment. Yeah, I was scanning through our components and thinking the same thing. Open to suggestions. :-)
Contributor
There was a problem hiding this comment. Ah, of course - my own words turned against me. In that case, carry on. |
||
| styleUrls: ['./summary-list.component.scss'], | ||
| changeDetection: ChangeDetectionStrategy.OnPush, | ||
| template: ` | ||
| <div class="summary-list full-container"> | ||
| <div class="summary-header" *ngIf="this.title || this.icon"> | ||
| <ht-icon class="summary-icon" [icon]="this.icon"></ht-icon> | ||
| <ht-label class="summary-title" [label]="this.title"></ht-label> | ||
| </div> | ||
| <ng-container *ngFor="let item of this.items"> | ||
| <ht-label class="summary-value-title" [label]="this.getFormattedLabel(item.label)"></ht-label> | ||
| <ul class="summary-value-list"> | ||
| <li class="summary-value" *ngIf="this.getValuesArray(item.value).length === 0">None</li> | ||
| <li class="summary-value" *ngFor="let value of this.getValuesArray(item.value)">{{ value }}</li> | ||
| </ul> | ||
| </ng-container> | ||
| </div> | ||
| ` | ||
| }) | ||
| export class SummaryListComponent { | ||
| @Input() | ||
| public title?: string; | ||
|
|
||
| @Input() | ||
| public icon?: IconType; | ||
|
|
||
| @Input() | ||
| public items?: SummaryItem[] = []; | ||
|
|
||
| public getFormattedLabel(label: string): string { | ||
| return startCase(label.toLowerCase()); | ||
| } | ||
|
|
||
| public getValuesArray(value: PrimitiveValue | PrimitiveValue[]): PrimitiveValue[] { | ||
| return Array.isArray(value) ? value : [value]; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| import { CommonModule } from '@angular/common'; | ||
| import { NgModule } from '@angular/core'; | ||
| import { FormattingModule } from '@hypertrace/common'; | ||
| import { IconModule } from '../icon/icon.module'; | ||
| import { LabelModule } from '../label/label.module'; | ||
| import { LoadAsyncModule } from '../load-async/load-async.module'; | ||
| import { SummaryListComponent } from './summary-list.component'; | ||
|
|
||
| @NgModule({ | ||
| declarations: [SummaryListComponent], | ||
| exports: [SummaryListComponent], | ||
| imports: [CommonModule, LoadAsyncModule, FormattingModule, LabelModule, IconModule] | ||
| }) | ||
| export class SummaryListModule {} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.