Skip to content
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.

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

[AlertGroup]: Missing documentation about template usage #467

Merged
merged 5 commits into from
Oct 21, 2024

Conversation

RiinaKuu
Copy link
Contributor

@RiinaKuu RiinaKuu commented Oct 17, 2024

https://funidata.atlassian.net/browse/DS-355

  • Added documentation for using <fudis-alert-group /> in the application template.
  • Moved AlertGroup to the bottom element of Dialog Component

@RiinaKuu RiinaKuu added the chore Maintenance and refactoring related issue label Oct 17, 2024
@github-actions github-actions bot temporarily deployed to Documentation for branch DS-355-update-alert-docs October 17, 2024 09:26 Destroyed
@@ -9,6 +9,12 @@ import { AlertGroupComponent } from "./alert-group/alert-group.component.ts";

Alert Group Component displays list of toaster-like Alert Components with four variants: `success`, `info`, `warning` and `danger.` These variants are the same ones as with [Notification Component](/docs/components-notification--documentation).

## Usage Guidelines

First, add `<fudis-alert-group />` HTML tag in the application template, preferably somewhere up in the application's DOM, e.g. `app.component.html`.
Copy link
Contributor

Choose a reason for hiding this comment

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

For the DOM structure we should probably instruct to put component as the "bottom element" of app.component.html etc. as that will make it more likely, that it will appear as the top element, even top of Navigation. This probably should be fixed in our examples and in our Dialog component as well, that Alert Group is last and not first element in DOM.

@github-actions github-actions bot temporarily deployed to Documentation for branch DS-355-update-alert-docs October 21, 2024 11:58 Destroyed
@videoeero videoeero merged commit 1e51376 into main Oct 21, 2024
10 checks passed
@videoeero videoeero deleted the DS-355-update-alert-docs branch October 21, 2024 12:33
@github-actions github-actions bot locked and limited conversation to collaborators Oct 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
chore Maintenance and refactoring related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants