mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-10-30 18:17:55 +00:00
e61bd967e3
* move script to scripts folder * add docfy to router and scripts * add docfy to router and scripts * fix jsdoc syntax * add component markdown files to gitignore * improve error handling for scripts * tidy up remaining jsdoc syntax * add sample jsdoc components * add known issue info * make not using multi-line components clearer * make generating docs clearer * update copy * final how to docfy cleanup * fix ts file @module syntax * fix read more syntax * make docfy typescript compatible
32 lines
1.7 KiB
JavaScript
32 lines
1.7 KiB
JavaScript
/**
|
|
* Copyright (c) HashiCorp, Inc.
|
|
* SPDX-License-Identifier: BUSL-1.1
|
|
*/
|
|
import Component from '@glimmer/component';
|
|
|
|
/**
|
|
* @module ConfirmationModal
|
|
* ConfirmationModal components wrap the Hds::Modal component to present a critical (red) type-to-confirm modal
|
|
* which require the user to type something to confirm the action.
|
|
* They are used for extremely destructive actions that require extra consideration before confirming.
|
|
*
|
|
* @example
|
|
* button is not part of component and is just to help demo functionality
|
|
* <Hds::Button @text="Confirm" @color="secondary" {{on "click" (fn (mut this.isModalOpen) true)}} />
|
|
* <ConfirmationModal @onConfirm={{fn (mut this.isModalOpen) false}} @title="Do Dangerous Thing?" @isActive={{this.isModalOpen}} @onClose={{fn (mut this.isModalOpen) false}} @confirmText="yes" @onConfirmMsg="deleting this thing to delete." />
|
|
*
|
|
* @param {function} onConfirm - onConfirm is the action that happens when user clicks onConfirm after filling in the confirmation block
|
|
* @param {function} onClose - specify what to do when user attempts to close modal
|
|
* @param {boolean} isActive - Controls whether the modal is "active" eg. visible or not.
|
|
* @param {string} title - Title of the modal
|
|
* @param {string} [confirmText=Yes] - The confirmation text that the user must type before continuing
|
|
* @param {string} [toConfirmMsg] - Finishes the sentence "Type `<confirmText>` to confirm `<toConfirmMsg>`", default is an empty string (ex. 'secret deletion')
|
|
* @param {string} [buttonText=Confirm] - Button text on the confirm button
|
|
*/
|
|
|
|
export default class ConfirmationModal extends Component {
|
|
get confirmText() {
|
|
return this.args.confirmText || 'Yes';
|
|
}
|
|
}
|