Skip to content

Add feedback message parameter to banner component #620

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

Closed
olxmpe wants to merge 4 commits into from
Closed

Add feedback message parameter to banner component #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ef73f9
Add feedback message parameter to banner component
olxmpe Jan 19, 2026
c006d4e
Fix test
olxmpe Jan 19, 2026
a2f5de7
Review
olxmpe Jan 19, 2026
ce5f0e3
Facultative feedbackMessage.value
olxmpe Jan 19, 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
60 changes: 34 additions & 26 deletions addon/components/o-s-s/banner.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,38 @@
<div class="upf-banner fx-1 fx-row fx-xalign-center fx-gap-px-12 {{this.modifierClasses}}"
...attributes>
{{#if (has-block "custom-icon")}}
<div>{{yield to="custom-icon"}}</div>
{{else if @icon}}
<OSS::Icon @style={{fa-icon-style @icon}} @icon={{fa-icon-value @icon}}
class="upf-badge upf-badge--shape-round upf-badge--size-md" />
{{else if @image}}
<img class="upf-badge upf-badge--size-md upf-badge--shape-round" src={{@image}} alt="banner" />
{{/if}}
<div class="fx-col fx-1 {{if (not-eq @size 'sm') 'fx-gap-px-3'}}">
{{#if @title}}
<div class="fx-row fx-xalign-center">
<span class="font-weight-semibold text-size-5 font-color-gray-900">{{@title}}</span>
{{#if (has-block "title-suffix")}}
{{yield to="title-suffix"}}
{{/if}}
</div>
{{/if}}
{{#if @subtitle}}
<span class="text-size-4 font-color-gray-500">{{@subtitle}}</span>
<div class="fx-col fx-gap-px-6">
<div class="upf-banner fx-1 fx-row fx-xalign-center fx-gap-px-12 {{this.modifierClasses}}" ...attributes>
{{#if (has-block "custom-icon")}}
<div>{{yield to="custom-icon"}}</div>
{{else if @icon}}
<OSS::Icon
@style={{fa-icon-style @icon}}
@icon={{fa-icon-value @icon}}
class="upf-badge upf-badge--shape-round upf-badge--size-md"
/>
{{else if @image}}
<img class="upf-badge upf-badge--size-md upf-badge--shape-round" src={{@image}} alt="banner" />
{{/if}}
{{#if (has-block "secondary-actions")}}
{{yield to="secondary-actions"}}
<div class="fx-col fx-1 {{if (not-eq @size 'sm') 'fx-gap-px-3'}}">
{{#if @title}}
<div class="fx-row fx-xalign-center">
<span class="font-weight-semibold text-size-5 font-color-gray-900">{{@title}}</span>
{{#if (has-block "title-suffix")}}
{{yield to="title-suffix"}}
{{/if}}
</div>
{{/if}}
{{#if @subtitle}}
<span class="text-size-4 font-color-gray-500">{{@subtitle}}</span>
{{/if}}
{{#if (has-block "secondary-actions")}}
{{yield to="secondary-actions"}}
{{/if}}
</div>
{{#if (has-block "actions")}}
<div>{{yield to="actions"}}</div>
{{/if}}
</div>
{{#if (has-block "actions")}}
<div>{{yield to="actions"}}</div>

{{#if @feedbackMessage.value}}
<span class="font-color-error-500">{{@feedbackMessage.value}}</span>
{{/if}}
</div>
</div>
10 changes: 10 additions & 0 deletions addon/components/o-s-s/banner.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@ export default {
type: 'boolean'
}
},
feedbackMessage: {
description: 'An error message that will be displayed below the banner.',
table: {
type: {
summary: '{ type: string, value: string }'
},
defaultValue: { summary: 'undefined' }
},
control: { type: 'object' }
},
size: {
description:
'Allows to adjust the size of the component. Currently available options are `sm`, `md` and `lg`. Defaults to `md`.',
Expand Down
8 changes: 7 additions & 1 deletion addon/components/o-s-s/banner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { isBlank } from '@ember/utils';
import Component from '@glimmer/component';
import type { FeedbackMessage } from './input-container';

type SizeType = 'sm' | 'md' | 'lg';

Expand All @@ -8,6 +9,7 @@ interface OSSBannerArgs {
plain?: boolean;
selected?: boolean;
disabled?: boolean;
feedbackMessage?: FeedbackMessage;
Copy link
Member

@Miexil Miexil Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@phndiaye & @JulienVannier66 wdyt about adding the hasError: boolean counterpart here ?
It basically shows the red border when truthy

Copy link
Contributor

@JulienVannier66 JulienVannier66 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, go add this only for the red border. But can we found a more general solution for other feedback border?

}

const SIZE_CLASSES: Record<string, string> = {
Expand All @@ -24,6 +26,10 @@ export default class OSSBanner extends Component<OSSBannerArgs> {
return this.args.selected ? 'upf-banner--selected' : '';
}

get errorClass(): string {
return this.args.feedbackMessage ? 'upf-banner--error' : '';
}

get plainClass(): string {
return this.args.plain ? 'background-color-gray-50' : 'background-color-white';
}
Expand All @@ -33,7 +39,7 @@ export default class OSSBanner extends Component<OSSBannerArgs> {
}

get modifierClasses(): string {
return [this.disabledClass, this.selectedClass, this.plainClass, this.sizeClass]
return [this.disabledClass, this.selectedClass, this.plainClass, this.sizeClass, this.errorClass]
.filter((mc) => !isBlank(mc))
.join(' ');
}
Expand Down
4 changes: 4 additions & 0 deletions app/styles/banner.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
transition: ease-in-out 0.25s;
}

&--error {
border: 1px solid var(--color-error-500);
}

&--disabled {
background-color: var(--color-gray-100);
border: 1px solid var(--color-border-default);
Expand Down
18 changes: 18 additions & 0 deletions tests/dummy/app/templates/index.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,24 @@
</:actions>
</OSS::Banner>
</div>
<div class="fx-row fx-gap-px-12">
<OSS::Banner
@title="Error"
@subtitle="A banner with a feedback message"
@feedbackMessage={{hash type="error" value="This is a feedback message"}}
/>
<OSS::Banner
@icon="fas fa-alicorn"
@title="Another error"
@selected={{true}}
@subtitle="Another banner with a feedback message"
@feedbackMessage={{hash type="error" value="This is another feedback message"}}
>
<:actions>
<OSS::RadioButton @selected={{true}} />
</:actions>
</OSS::Banner>
</div>
</div>
</div>

Expand Down
28 changes: 28 additions & 0 deletions tests/integration/components/o-s-s/banner-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,36 @@ module('Integration | Component | o-s-s/banner', function (hooks) {

test("when the value is undefined, it doesn't add the size class", async function (assert) {
await render(hbs`<OSS::Banner />`);

assert.dom('.upf-banner.upf-banner--size-sm').doesNotExist();
assert.dom('.upf-banner.upf-banner--size-lg').doesNotExist();
});
});

module('@feedbackMessage parameter', function () {
hooks.beforeEach(function () {
this.feedbackMessage = {
type: 'error',
value: 'This is a feedback message'
};
});

test('When parameter is passed, it adds upf-banner--error class', async function (assert) {
await render(hbs`<OSS::Banner @feedbackMessage={{this.feedbackMessage}} />`);

assert.dom('.upf-banner.upf-banner--error').exists();
});

test('When parameter is passed, the feedback message is swhown', async function (assert) {
await render(hbs`<OSS::Banner @feedbackMessage={{this.feedbackMessage}} />`);

assert.dom('.font-color-error-500').hasText('This is a feedback message');
});

test('When parameter is not passed, it does not add upf-banner--error class', async function (assert) {
await render(hbs`<OSS::Banner />`);

assert.dom('.upf-banner.upf-banner--error').doesNotExist();
});
});
});
Loading