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 Modal component #116

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

Additional API methods for the Modal component #116

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

Comments

@VizuaaLOG
Copy link
Owner

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 modal, any other ideas please just comment!

  • toggle() - Toggles the visibility of the message
  • 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 alert is visible, false otherwise
  • buttons(config: array) - Sets the button configuration, replacing the existing one with the one. Returns the current configuration if no parameters are provided
  • closable(new_state: boolean) - Sets the closable flag on the modal. Will return the current value if no parameters are provided
  • load(url: string, stripScripts: boolean) - Will reload the contents of the modal via AJAX using the given URL. stripScripts will default to true, setting to false will allow script tags in the rendered HTML.
  • trigger(event_name: string) - This will trigger the provided event on the alert instance. Note: This wouldn't be restricted to documented events, so could be used for handling custom events

Options
Addition of a new bodyUrlAllowScripts flag that will default to false but will mimic the behaviour of the load method's second parameter.

Deprecations
Deprecate the current onClose and onOpen properties in favour of using the on method.

@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