Skip to content

Improve deprecated attribute or nested component visibility #500

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
philipsens merged 3 commits into from
Jul 31, 2026
Merged

Improve deprecated attribute or nested component visibility #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb16f3f
Improve visibility of deprecated attributes
Matthbo Jul 20, 2026
85140e7
Also for nested components
Matthbo Jul 20, 2026
305e215
Replace icon and hover text for dedicated description text
Matthbo Jul 31, 2026
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
24 changes: 11 additions & 13 deletions ...ails/details-element/details-element-attributes/details-element-attributes.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,31 +75,29 @@
<tr
class="border-top"
[ngClass]="{
'padding-bottom': !attribute.enum && !attribute.description,
'padding-bottom': !attribute.enum && !attribute.description && !attribute.deprecated,
deprecated: attribute.deprecated,
forRemoval: attribute.deprecated && attribute.deprecated.forRemoval,
}"
>
<td
class="name"
[title]="attribute.deprecated ? getDeprecatedTitle(attribute.deprecated) : ''"
[innerHTML]="attributeEntry.name | nameWbr"
></td>
<td class="name" [innerHTML]="attributeEntry.name | nameWbr"></td>
<td>{{ attribute.enum ? 'options' : getFriendlyType(attribute.type) }}</td>
<td
class="attribute-default-value"
*fdJavadocTransform="let text of attribute.default ?? DEFAULT_RETURN_CHARACTER; elements: elements()"
[innerHTML]="text"
></td>
</tr>
@if (attribute.description) {
@if (attribute.description || attribute.deprecated) {
<tr [ngClass]="{ 'padding-bottom': !attribute.enum }">
<td
colspan="3"
class="description"
*fdJavadocTransform="let text of attribute.description; elements: elements()"
[innerHTML]="text"
></td>
<td colspan="3" class="description">
@if (attribute.deprecated) {
<div class="deprecated-text">{{ getDeprecatedDescription(attribute.deprecated) }}</div>
}
@if (attribute.description) {
<div *fdJavadocTransform="let text of attribute.description; elements: elements()" [innerHTML]="text"></div>
}
</td>
</tr>
}
@if (attribute.enum) {
Expand Down
15 changes: 12 additions & 3 deletions ...etails/details-element/details-element-attributes/details-element-attributes.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { CollapseDirective } from '../../../../components/collapse.directive';
import { NameWbrPipe } from '../../../../components/name-wbr.pipe';
import { IconCaretComponent } from '../../../../icons/icon-caret-down/icon-caret.component';
import { DEFAULT_RETURN_CHARACTER } from '../../../../app.constants';
import { IconHelpComponent } from '../../../../icons/icon-help/icon-help.component';

type EnumValueEntry = {
valueName: string;
Expand All @@ -21,7 +22,15 @@ type EnumValueEntry = {

@Component({
selector: 'app-details-element-attributes',
imports: [IconCaretComponent, NgTemplateOutlet, JavadocTransformDirective, NameWbrPipe, NgClass, CollapseDirective],
imports: [
IconCaretComponent,
NgTemplateOutlet,
JavadocTransformDirective,
NameWbrPipe,
NgClass,
CollapseDirective,
IconHelpComponent,
],
templateUrl: './details-element-attributes.component.html',
styleUrl: '../details-element-options.scss',
})
Expand All @@ -44,8 +53,8 @@ export class DetailsElementAttributesComponent {
return this.getInheritedCollapseOptions(this.inheritedCollapseOptions, parentElementName, defaultValue);
}

protected getDeprecatedTitle(deprecatedInfo: DeprecationInfo): string {
return `${deprecatedInfo.description ?? 'This has been deprecated!'}${deprecatedInfo.since ? `\nSince ${deprecatedInfo.since}` : ''}`;
protected getDeprecatedDescription(deprecatedInfo: DeprecationInfo): string {
return `${deprecatedInfo.description ?? 'This has been deprecated'}${deprecatedInfo.since ? `\nSince ${deprecatedInfo.since}` : ''}`;
}

protected getFriendlyType(type: Attribute['type']): string {
Expand Down
5 changes: 0 additions & 5 deletions ...iews/details/details-element/details-element-nested/details-element-nested.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@
[ngClass]="{ deprecated: nestedElement.deprecated, 'padding-bottom': !nestedElement.type }"
>
<td class="name" [innerHTML]="nestedElement.roleName | nameWbr"></td>
<td
class="description"
*fdJavadocTransform="let text of nestedElement.description ?? DEFAULT_RETURN_CHARACTER; elements: elements()"
[innerHTML]="text"
></td>
<td>{{ nestedElement.mandatory ? '1' : '0' }} .. {{ nestedElement.multiple ? 'n' : '1' }}</td>
</tr>
@if (nestedElement.type) {
Expand Down
3 changes: 2 additions & 1 deletion .../views/details/details-element/details-element-nested/details-element-nested.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ import { JavadocTransformDirective } from '@frankframework/doc-library-ng';
import { DEFAULT_RETURN_CHARACTER } from '../../../../app.constants';
import { AppService } from '../../../../app.service';
import { NameWbrPipe } from '../../../../components/name-wbr.pipe';
import { IconHelpComponent } from '../../../../icons/icon-help/icon-help.component';

@Component({
selector: 'app-details-element-nested',
imports: [JavadocTransformDirective, NameWbrPipe, NgClass, RouterLink],
imports: [JavadocTransformDirective, NameWbrPipe, NgClass, RouterLink, IconHelpComponent],
templateUrl: './details-element-nested.component.html',
styleUrl: '../details-element-options.scss',
})
Expand Down
7 changes: 7 additions & 0 deletions frank-doc-frontend/src/app/views/details/details-element/details-element-options.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ table {

tr.deprecated > td:first-child {
text-decoration: line-through;
position: relative;

&.forRemoval {
color: var(--color-alert-error);
text-decoration-color: var(--color-alert-error);
}
}
Expand Down Expand Up @@ -89,6 +91,11 @@ table {
.description {
margin-bottom: 2em;
color: var(--color-gray-dark);

.deprecated-text {
font-style: italic;
white-space: pre-line;
}
}

.options-sub-title {
Expand Down
Loading