mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-16 10:51:06 +00:00
chore: complete first pass of apply jsdoc annotations to component props
This commit is contained in:
parent
566a281d81
commit
f30755b237
97 changed files with 2327 additions and 259 deletions
|
@ -18,13 +18,13 @@
|
|||
export let danger = false;
|
||||
|
||||
/**
|
||||
* Define a class for the inner modal
|
||||
* Specify a class for the inner modal
|
||||
* @type {string} [containerClass=""]
|
||||
*/
|
||||
export let containerClass = "";
|
||||
|
||||
/**
|
||||
* 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]";
|
||||
|
|
|
@ -1,5 +1,14 @@
|
|||
<script>
|
||||
/**
|
||||
* 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;
|
||||
</script>
|
||||
|
||||
|
|
|
@ -1,9 +1,38 @@
|
|||
<script>
|
||||
export let primaryClass = undefined;
|
||||
/**
|
||||
* 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;
|
||||
export let secondaryClass = undefined;
|
||||
|
||||
/**
|
||||
* Specify a class for the primary button
|
||||
* @type {string} [primaryClass]
|
||||
*/
|
||||
export let primaryClass = undefined;
|
||||
|
||||
/**
|
||||
* Specify the secondary button text
|
||||
* @type {string} [secondaryButtonText=""]
|
||||
*/
|
||||
export let secondaryButtonText = "";
|
||||
|
||||
/**
|
||||
* Specify a class for the secondary button
|
||||
* @type {string} [secondaryClass]
|
||||
*/
|
||||
export let secondaryClass = undefined;
|
||||
|
||||
/**
|
||||
* Set to `true` to use the danger variant
|
||||
* @type {boolean} [danger=false]
|
||||
*/
|
||||
export let danger = false;
|
||||
|
||||
import { getContext } from "svelte";
|
||||
|
|
|
@ -1,10 +1,44 @@
|
|||
<script>
|
||||
/**
|
||||
* Specify the modal title
|
||||
* @type {string} [title=""]
|
||||
*/
|
||||
export let title = "";
|
||||
|
||||
/**
|
||||
* Specify the modal label
|
||||
* @type {string} [label=""]
|
||||
*/
|
||||
export let label = "";
|
||||
|
||||
/**
|
||||
* Specify the label class
|
||||
* @type {string} [labelClass=""]
|
||||
*/
|
||||
export let labelClass = "";
|
||||
|
||||
/**
|
||||
* Specify the title class
|
||||
* @type {string} [titleClass=""]
|
||||
*/
|
||||
export let titleClass = "";
|
||||
|
||||
/**
|
||||
* Specify the close class
|
||||
* @type {string} [closeClass=""]
|
||||
*/
|
||||
export let closeClass = "";
|
||||
|
||||
/**
|
||||
* Specify the close icon class
|
||||
* @type {string} [closeIconClass=""]
|
||||
*/
|
||||
export let closeIconClass = "";
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the close icon
|
||||
* @type {string} [iconDescription="Close"]
|
||||
*/
|
||||
export let iconDescription = "Close";
|
||||
|
||||
import { getContext } from "svelte";
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue