mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-18 11:36:36 +00:00
feat(code-snippet): support disabled state for single and multi-line types
This commit is contained in:
parent
524b5080a6
commit
3dde418398
6 changed files with 37 additions and 2 deletions
|
@ -496,6 +496,7 @@ None.
|
||||||
| type | <code>let</code> | No | <code>"single" | "inline" | "multi"</code> | <code>"single"</code> | Set the type of code snippet |
|
| type | <code>let</code> | No | <code>"single" | "inline" | "multi"</code> | <code>"single"</code> | Set the type of code snippet |
|
||||||
| code | <code>let</code> | No | <code>string</code> | -- | Set the code snippet text<br />Alternatively, use the default slot (e.g., <CodeSnippet>{`code`}</CodeSnippet>) |
|
| code | <code>let</code> | No | <code>string</code> | -- | Set the code snippet text<br />Alternatively, use the default slot (e.g., <CodeSnippet>{`code`}</CodeSnippet>) |
|
||||||
| hideCopyButton | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to hide the copy button |
|
| hideCopyButton | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to hide the copy button |
|
||||||
|
| disabled | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the disabled variant<br />Only applies to the "single", "multi" types |
|
||||||
| wrapText | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to wrap the text<br />Note that `type` must be "multi" |
|
| wrapText | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to wrap the text<br />Note that `type` must be "multi" |
|
||||||
| light | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable the light variant |
|
| light | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable the light variant |
|
||||||
| skeleton | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to display the skeleton state |
|
| skeleton | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to display the skeleton state |
|
||||||
|
|
|
@ -1949,6 +1949,16 @@
|
||||||
"constant": false,
|
"constant": false,
|
||||||
"reactive": false
|
"reactive": false
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"name": "disabled",
|
||||||
|
"kind": "let",
|
||||||
|
"description": "Set to `true` for the disabled variant\nOnly applies to the \"single\", \"multi\" types",
|
||||||
|
"type": "boolean",
|
||||||
|
"value": "false",
|
||||||
|
"isFunction": false,
|
||||||
|
"constant": false,
|
||||||
|
"reactive": false
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "wrapText",
|
"name": "wrapText",
|
||||||
"kind": "let",
|
"kind": "let",
|
||||||
|
|
|
@ -47,6 +47,14 @@ let comment = `
|
||||||
|
|
||||||
<CodeSnippet type="multi" {code} hideCopyButton />
|
<CodeSnippet type="multi" {code} hideCopyButton />
|
||||||
|
|
||||||
|
### Disabled
|
||||||
|
|
||||||
|
The `disabled` prop applies only to the `"single"` and `"multi"` code snippet types.
|
||||||
|
|
||||||
|
<CodeSnippet disabled>yarn add -D carbon-components-svelte</CodeSnippet>
|
||||||
|
<br />
|
||||||
|
<CodeSnippet disabled type="multi" code="{comment}" />
|
||||||
|
|
||||||
### Wrapped text
|
### Wrapped text
|
||||||
|
|
||||||
`wrapText` only applies to the `"multi"` type.
|
`wrapText` only applies to the `"multi"` type.
|
||||||
|
|
|
@ -18,6 +18,12 @@
|
||||||
/** Set to `true` to hide the copy button */
|
/** Set to `true` to hide the copy button */
|
||||||
export let hideCopyButton = false;
|
export let hideCopyButton = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set to `true` for the disabled variant
|
||||||
|
* Only applies to the "single", "multi" types
|
||||||
|
*/
|
||||||
|
export let disabled = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set to `true` to wrap the text
|
* Set to `true` to wrap the text
|
||||||
* Note that `type` must be "multi"
|
* Note that `type` must be "multi"
|
||||||
|
@ -149,6 +155,7 @@
|
||||||
class:bx--snippet--single="{type === 'single'}"
|
class:bx--snippet--single="{type === 'single'}"
|
||||||
class:bx--snippet--inline="{type === 'inline'}"
|
class:bx--snippet--inline="{type === 'inline'}"
|
||||||
class:bx--snippet--multi="{type === 'multi'}"
|
class:bx--snippet--multi="{type === 'multi'}"
|
||||||
|
class:bx--snippet--disabled="{type !== 'inline' && disabled}"
|
||||||
{...$$restProps}
|
{...$$restProps}
|
||||||
on:mouseover
|
on:mouseover
|
||||||
on:mouseenter
|
on:mouseenter
|
||||||
|
@ -156,7 +163,7 @@
|
||||||
>
|
>
|
||||||
<div
|
<div
|
||||||
role="{type === 'single' ? 'textbox' : undefined}"
|
role="{type === 'single' ? 'textbox' : undefined}"
|
||||||
tabindex="{type === 'single' ? '0' : undefined}"
|
tabindex="{type === 'single' && !disabled ? '0' : undefined}"
|
||||||
aria-label="{$$restProps['aria-label'] || copyLabel || 'code-snippet'}"
|
aria-label="{$$restProps['aria-label'] || copyLabel || 'code-snippet'}"
|
||||||
class:bx--snippet-container="{true}"
|
class:bx--snippet-container="{true}"
|
||||||
>
|
>
|
||||||
|
@ -168,6 +175,7 @@
|
||||||
</div>
|
</div>
|
||||||
{#if !hideCopyButton}
|
{#if !hideCopyButton}
|
||||||
<CopyButton
|
<CopyButton
|
||||||
|
disabled="{disabled}"
|
||||||
feedback="{feedback}"
|
feedback="{feedback}"
|
||||||
feedbackTimeout="{feedbackTimeout}"
|
feedbackTimeout="{feedbackTimeout}"
|
||||||
iconDescription="{copyButtonDescription}"
|
iconDescription="{copyButtonDescription}"
|
||||||
|
@ -180,6 +188,7 @@
|
||||||
kind="ghost"
|
kind="ghost"
|
||||||
size="small"
|
size="small"
|
||||||
class="bx--snippet-btn--expand"
|
class="bx--snippet-btn--expand"
|
||||||
|
disabled="{disabled}"
|
||||||
on:click="{() => {
|
on:click="{() => {
|
||||||
expanded = !expanded;
|
expanded = !expanded;
|
||||||
}}"
|
}}"
|
||||||
|
|
|
@ -47,4 +47,4 @@ export function subtract(a: number, b: number) {
|
||||||
|
|
||||||
<CodeSnippet skeleton />
|
<CodeSnippet skeleton />
|
||||||
|
|
||||||
<CodeSnippet type="multi" skeleton />
|
<CodeSnippet type="multi" disabled skeleton />
|
||||||
|
|
7
types/CodeSnippet/CodeSnippet.d.ts
vendored
7
types/CodeSnippet/CodeSnippet.d.ts
vendored
|
@ -25,6 +25,13 @@ export interface CodeSnippetProps {
|
||||||
*/
|
*/
|
||||||
hideCopyButton?: boolean;
|
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
|
* Set to `true` to wrap the text
|
||||||
* Note that `type` must be "multi"
|
* Note that `type` must be "multi"
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue