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

Additional API methods for the message component #115

Open
VizuaaLOG opened this issue Nov 26, 2020 · 0 comments
Open

Additional API methods for the message component #115

VizuaaLOG opened this issue Nov 26, 2020 · 0 comments
Assignees
Milestone

Comments

@VizuaaLOG
Copy link
Owner

VizuaaLOG commented Nov 26, 2020

Over the next few versions I think it would great to expand the API methods available, allowing certain settings to be changed at run time, rather than needing to recreate the component. The below are ideas for the message, any other ideas please just comment!

  • hide() - Hides the message
  • show() - Shows the message
  • toggle() - Toggles the visibility of the message
  • type(new_type: string) - Changes the message's type, adjusting the CSS classes applied
  • title(new_title: string) - Changes the title of the message
  • body(new_body: string) - Changes the body of the message
  • isVisible(): boolean - Returns true if the notification is visible, false otherwise
  • dismissable(new_state: boolean) - Sets if the message is dismissable, returns the current value if no parameters are provided
  • dismissInterval(new_value: number) - Sets the message's dismiss interval, returns the current value if no parameters are provided
  • destroyOnDismiss(new_state: boolean) - Sets if the message is destroyed when dismissed, returns the current value if no parameters are provided
  • size(new_value: string) - Sets the size of the message, returns the current value if no parameters are provided
  • trigger(event_name: string) - This will trigger the provided event on the notification instance. Note: This wouldn't be restricted to documented events, so could be used for handling custom events

The current color property will be renamed to type to keep in line with other dismissable components, primarily the notification.

@VizuaaLOG VizuaaLOG self-assigned this Nov 26, 2020
@VizuaaLOG VizuaaLOG added this to the 0.13 milestone Jan 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant