mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-15 18:31:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore: complete first pass of apply jsdoc annotations to component props

Browse source
This commit is contained in:
Eric Liu 2020-07-26 17:42:12 -07:00
commit f30755b237
97 changed files with 2327 additions and 259 deletions
Download patch file Download diff file Expand all files Collapse all files

61
src/Modal/Modal.svelte
View file

@ -23,19 +23,68 @@
*/
export let passiveModal = false;
export let hasForm = false;
export let hasScrollingContent = false;
export let primaryButtonDisabled = false;
export let shouldSubmitOnEnter = true;
export let modalAriaLabel = undefined;
/**
* Specify the modal heading
* @type {string} [modalHeading]
*/
export let modalHeading = undefined;
/**
* Specify the modal label
* @type {string} [modalLabel]
*/
export let modalLabel = undefined;
/**
* Specify the ARIA label for the modal
* @type {string} [modalAriaLabel]
*/
export let modalAriaLabel = undefined;
/**
* Specify the ARIA label for the close icon
* @type {string} [iconDescription="Close the modal"]
*/
export let iconDescription = "Close the modal";
/**
* Set to `true` if the modal contains form elements
* @type {boolean} [hasForm=false]
*/
export let hasForm = false;
/**
* Set to `true` if the modal contains scrolling content
* @type {boolean} [hasScrollingContent=false]
*/
export let hasScrollingContent = false;
/**
* Specify the primary button text
* @type {string} [primaryButtonText=""]
*/
export let primaryButtonText = "";
/**
* Set to `true` to disable the primary button
* @type {boolean} [primaryButtonDisabled=false]
*/
export let primaryButtonDisabled = false;
/**
* Set to `true` for the primary button to be triggered when pressing "Enter"
* @type {boolean} [shouldSubmitOnEnter=true]
*/
export let shouldSubmitOnEnter = true;
/**
* Specify the secondary button text
* @type {string} [secondaryButtonText=""]
*/
export let secondaryButtonText = "";
/**
* Define a selector to be focused when opening the modal
* Specify a selector to be focused when opening the modal
* @type {string} [selectorPrimaryFocus="[data-modal-primary-focus]"]
*/
export let selectorPrimaryFocus = "[data-modal-primary-focus]";