carbon-components-svelte/types/Slider/Slider.svelte.d.ts
metonym 1ccdf64504
feat(slider): add fullWidth prop (#1354)
The `bx--slider` class in the `Slider` component has max-width of `40rem`. Because `$$restProps` is spread to the top-level `div` element in `Slider`, the only way to override the style is to do so globally:

```css
:global(.bx--slider-container) {
  width: 100%;
}

:global(.bx--slider) {
  max-width: none;
}
```

This adds a `fullWidth` prop that sets a full width style using inline style attributes.
2022-06-18 12:47:10 -07:00

126 lines
2.1 KiB
TypeScript

/// <reference types="svelte" />
import type { SvelteComponentTyped } from "svelte";
export interface SliderProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Specify the value of the slider
* @default 0
*/
value?: number;
/**
* Set the maximum slider value
* @default 100
*/
max?: number;
/**
* Specify the label for the max value
* @default ""
*/
maxLabel?: string;
/**
* Set the minimum slider value
* @default 0
*/
min?: number;
/**
* Specify the label for the min value
* @default ""
*/
minLabel?: string;
/**
* Set the step value
* @default 1
*/
step?: number;
/**
* Set the step multiplier value
* @default 4
*/
stepMultiplier?: number;
/**
* Set to `true` to require a value
* @default false
*/
required?: boolean;
/**
* Specify the input type
* @default "number"
*/
inputType?: string;
/**
* Set to `true` to disable the slider
* @default false
*/
disabled?: boolean;
/**
* Set to `true` to enable the light variant
* @default false
*/
light?: boolean;
/**
* Set to `true` to hide the text input
* @default false
*/
hideTextInput?: boolean;
/**
* Set to `true` for the slider to span
* the full width of its containing element.
* @default false
*/
fullWidth?: boolean;
/**
* Set an id for the slider div element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Set to `true` to indicate an invalid state
* @default false
*/
invalid?: boolean;
/**
* Specify the label text
* @default ""
*/
labelText?: string;
/**
* Set a name for the slider element
* @default ""
*/
name?: string;
/**
* Obtain a reference to the HTML element
* @default null
*/
ref?: null | HTMLDivElement;
}
export default class Slider extends SvelteComponentTyped<
SliderProps,
{
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
change: CustomEvent<any>;
},
{ labelText: {} }
> {}