mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
f2a3f8d2e1* chore(deps-dev): bump devDependencies * docs: update number of available carbon icons * feat(notification): distinguish dispatched close event between click/timeout * fix(notification): prevent class from being overriden by $$restProps * docs(notification): improve example body copy * fix(notification): remove notificationType prop * refactor(notification): resolve svelte file in imports * fix(notification): prevent class from being overridden by $$restProps * feat(notification): update TS signature for dispatched close event * docs: update contributing * fix(loading): adjust spinner styles * feat(tag): support custom icon variant * feat(tile): add optional expand/collapse icon labels to ExpandableTile * feat(code-snippet): support disabled state for single and multi-line types * fix(code-snippet): remove impossible class directive * fix(code-snippet): showMoreLess button size should be "field", not "small" * fix(password-input): disable visibility button - set default values for tooltipAlignment, tooltipPosition * fix(text-input): add missing warning field wrapper class * feat(button): infer hasIconOnly using $$slots API - requires Svelte version >=3.25 * docs(button): add danger tertiary, icon-only example * feat(button): set default values for tooltip alignment, position * docs: document dynamic theming * fix(modal): correctly set class props #482 * fix(form): forward submit event in FluidForm #487 * feat(dropdown): support warning state * feat(multi-select): support warning state * fix(multi-select): prevent dropdown from opening if disabled * feat(number-input): support warning state * chore(deps-dev): upgrade devDependencies * docs: bump @carbon/themes, carbon-components * refactor(data-table): co-locate DataTableSkeleton with DataTable * docs: update number of pictograms * fix(password-input): add missing "bx--btn" class to visibility toggle * docs: increase z-index for component preview
121 lines
2.6 KiB
TypeScript
121 lines
2.6 KiB
TypeScript
/// <reference types="svelte" />
|
|
|
|
export interface CodeSnippetProps {
|
|
/**
|
|
* Set the type of code snippet
|
|
* @default "single"
|
|
*/
|
|
type?: "single" | "inline" | "multi";
|
|
|
|
/**
|
|
* Set the code snippet text
|
|
* Alternatively, use the default slot (e.g., <CodeSnippet>{`code`}</CodeSnippet>)
|
|
*/
|
|
code?: string;
|
|
|
|
/**
|
|
* Set to `true` to expand a multi-line code snippet (type="multi")
|
|
* @default false
|
|
*/
|
|
expanded?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to hide the copy button
|
|
* @default false
|
|
*/
|
|
hideCopyButton?: boolean;
|
|
|
|
/**
|
|
* Set to `true` for the disabled variant
|
|
* Only applies to the "single", "multi" types
|
|
* @default false
|
|
*/
|
|
disabled?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to wrap the text
|
|
* Note that `type` must be "multi"
|
|
* @default false
|
|
*/
|
|
wrapText?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to enable the light variant
|
|
* @default false
|
|
*/
|
|
light?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to display the skeleton state
|
|
* @default false
|
|
*/
|
|
skeleton?: boolean;
|
|
|
|
/**
|
|
* Specify the ARIA label for the copy button icon
|
|
*/
|
|
copyButtonDescription?: string;
|
|
|
|
/**
|
|
* Specify the ARIA label of the copy button
|
|
*/
|
|
copyLabel?: string;
|
|
|
|
/**
|
|
* Specify the feedback text displayed when clicking the snippet
|
|
* @default "Copied!"
|
|
*/
|
|
feedback?: string;
|
|
|
|
/**
|
|
* Set the timeout duration (ms) to display feedback text
|
|
* @default 2000
|
|
*/
|
|
feedbackTimeout?: number;
|
|
|
|
/**
|
|
* Specify the show less text
|
|
* `type` must be "multi"
|
|
* @default "Show less"
|
|
*/
|
|
showLessText?: string;
|
|
|
|
/**
|
|
* Specify the show more text
|
|
* `type` must be "multi"
|
|
* @default "Show more"
|
|
*/
|
|
showMoreText?: string;
|
|
|
|
/**
|
|
* Set to `true` to enable the show more/less button
|
|
* @default false
|
|
*/
|
|
showMoreLess?: boolean;
|
|
|
|
/**
|
|
* Set an id for the code element
|
|
* @default "ccs-" + Math.random().toString(36)
|
|
*/
|
|
id?: string;
|
|
|
|
/**
|
|
* Obtain a reference to the pre HTML element
|
|
* @default null
|
|
*/
|
|
ref?: null | HTMLPreElement;
|
|
}
|
|
|
|
export default class CodeSnippet {
|
|
$$prop_def: CodeSnippetProps;
|
|
$$slot_def: {
|
|
default: {};
|
|
};
|
|
|
|
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
|
|
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
|
|
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
|
|
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
|
|
$on(eventname: "animationend", cb: (event: WindowEventMap["animationend"]) => void): () => void;
|
|
$on(eventname: string, cb: (event: Event) => void): () => void;
|
|
}
|