Skip to content

Types for Heading component #684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jialecl merged 2 commits into from
Feb 11, 2022
Merged

Types for Heading component #684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86cc449
[Minor] Added types for Heading component
Feb 11, 2022
f1d937e
Small change for level prop in Heading
Feb 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...mples/heading/properties/heading-table-properties/heading-table-properties.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<td>
<code>1</code>
</td>
<td>Defines the heading level from 1 to 5.</td>
<td>Defines the heading level from 1 to 5. The styles of the heading are applied according to the level.</td>
</tr>
<tr>
<td>text: string</td>
Expand Down
38 changes: 32 additions & 6 deletions projects/dxc-ngx-cdk/src/lib/dxc-heading/dxc-heading.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,45 @@ import { CssUtils } from "../utils";
import { BehaviorSubject } from "rxjs";
import { Component, Input, HostBinding, SimpleChanges } from "@angular/core";

type Space =
| "xxsmall"
| "xsmall"
| "small"
| "medium"
| "large"
| "xlarge"
| "xxlarge";

type Margin = {
top?: Space;
bottom?: Space;
left?: Space;
right?: Space;
};

@Component({
selector: "dxc-heading",
templateUrl: "./dxc-heading.component.html",
providers: [CssUtils],
})
export class DxcHeadingComponent {
@Input() level: number;
/**
* Defines the heading level from 1 to 5. The styles of the heading are applied according to the level.
*/
@Input() level: 1 | 2 | 3 | 4 | 5 = 1;
/**
* Heading text.
*/
@Input() text: string;
@Input() weight: string;
@Input() margin: string;
/**
* Modifies the default weight of the heading.
*/
@Input() weight: "light" | "normal" | "bold";
/**
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
*/
@Input() margin: Space | Margin;

@HostBinding("class") className;

Expand All @@ -27,9 +56,6 @@ export class DxcHeadingComponent {

ngOnInit() {
this.className = `${this.getDynamicStyle(this.defaultInputs.getValue())}`;
if (this.level == null) {
this.level = 1;
}
}

public ngOnChanges(changes: SimpleChanges): void {
Expand Down