svelte-tweakpane-ui
Version:
A Svelte component library wrapping UI elements from Tweakpane, plus some additional functionality for convenience and flexibility.
195 lines (194 loc) • 6.51 kB
TypeScript
import { SvelteComponent } from 'svelte'
import type { ValueChangeEvent } from '../utils.js'
import type { SliderInputBindingApi as GenericSliderRef } from 'tweakpane'
export type StepperChangeEvent = ValueChangeEvent<number>
declare const __propDef: {
props: {
/**
* A `number` value to control.
* @bindable
* */
value: number
} & Omit<
{
/**
* Minimum value.
*
* Specifying both a `min` and a `max` prop turns the control into a slider.
* @default `undefined`
*/
min?: number
/**
* Maximum value.
*
* Specifying both a `min` and a `max` prop turns the control into a slider.
* @default `undefined`
*/
max?: number
/**
* A function to customize the point value's string representation (e.g. rounding, etc.).
* @default `undefined` \
* Normal `.toString()` formatting.
*/
format?: ((value: number) => string) | undefined
/**
* The unit scale for key-based input for all dimensions (e.g. the up and down arrow keys).
* @default `1` \
* Or `stepValue` if defined.
*/
keyScale?: number
/**
* The unit scale for pointer-based input for all dimensions.
* @default `undefined` \
* [Dynamic based on magnitude of
* `value`](https://github.com/cocopon/tweakpane/blob/66dfbea04bfe9b7f031673c955ceda1f92356e75/packages/core/src/common/number/util.ts#L54).
*/
pointerScale?: number
/**
* The minimum step interval.
* @default `undefined` \
* No step constraint.
*/
step?: number
/**
* When `true`, expand the width of the control at the expense of the numeric input
* field.
* @default `false`
*/
wide?: boolean
} & {
/**
* A `number` value to control.
* @bindable
*/
value: number
} & Omit<
{
/**
* The binding's target object with values to manipulate.
* @bindable
*/
object: import('@tweakpane/core').Bindable & Record<string, number>
/** The key for the value in the target `object` that the control should manipulate. */
key: string
/**
* Prevent interactivity and gray out the control.
* @default `false`
*/
disabled?: boolean
/**
* Text displayed next to control.
* @default `undefined`
*/
label?: string | undefined
/**
* Tweakpane's internal options object.
*
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
*
* Valid types are contingent on the type of the value `key` points to in `object`.
*
* This is intended internal use, when implementing convenience components wrapping Binding's
* functionality. Options of interest are instead exposed as top-level props in _Svelte
* Tweakpane UI_.
* @default `undefined`
*/
options?: import('tweakpane').NumberInputParams | undefined
/**
* Custom color scheme.
*
* @default `undefined` \
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
* set with `setGlobalDefaultTheme()`.
*/
theme?: import('..').Theme | undefined
/**
* Reference to internal Tweakpane
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
* this control.
*
* This property is exposed for advanced use cases only, such as when implementing convenience
* components wrapping `<Binding>`'s functionality.
*
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
*
* @bindable
* @readonly
*/
ref?: GenericSliderRef | undefined
/**
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
* the `<Binding>`'s containing `<Pane>`.
*
* This property is exposed for advanced use cases only, such as when implementing convenience
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
*
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
*
* @default `undefined`
*/
plugin?: import('../utils.js').Plugin | undefined
},
'object' | 'key'
>,
'ref' | 'options' | 'plugin' | 'amount'
>
slots: {}
events: {
/**
* Fires when `value` changes.
*
* _This event is provided for advanced use cases. It's usually preferred to bind to the `value` prop instead._
*
* The `event.details` payload includes a copy of the value and an `origin` field to distinguish between user-interactive changes (`internal`)
* and changes resulting from programmatic manipulation of the `value` (`external`).
*
* @extends ValueChangeEvent
* @event
* */
change: StepperChangeEvent
}
}
export type StepperProps = typeof __propDef.props
export type StepperEvents = typeof __propDef.events
export type StepperSlots = typeof __propDef.slots
/**
* A control for simple incremental value changes.
*
* Similar in functionality to a `<Slider>`, but with nice big buttons to increment and decrement the value.
*
* Integrates the [Stepper](https://github.com/tallneil/tweakpane-plugin-inputs/blob/main/src/stepper/plugin.ts)
* control from [Neil Shankar's](https://tallneil.io/) ["Inputs for Tweakpane
* " plugin](https://github.com/tallneil/tweakpane-plugin-inputs).
*
* Usage outside of a `<Pane>` component will implicitly wrap the stepper in `<Pane position="inline">`.
*
* Note that _Svelte Tweakpane UI_ embeds a functionally identical [fork](https://github.com/kitschpatrol/tweakpane-plugin-inputs) of the plugin with build optimizations.
*
* @emits {StepperChangeEvent} change - When `value` changes. (This event is provided for advanced use cases. Prefer binding to `value`.)
*
* @example
* ```svelte
* <script lang="ts">
* import { Stepper } from 'svelte-tweakpane-ui'
* let angle = 45
* </script>
*
* <Stepper bind:value={angle} label="Angle" step={45} />
*
* <div class="demo" style:--a="{angle}deg"></div>
*
* <style>
* div.demo {
* aspect-ratio: 1;
* width: 100%;
* background: linear-gradient(var(--a), magenta, orange);
* }
* </style>
* ```
*
* @sourceLink
* [Stepper.svelte](https://github.com/kitschpatrol/svelte-tweakpane-ui/blob/main/src/lib/control/Stepper.svelte)
*/
export default class Stepper extends SvelteComponent<StepperProps, StepperEvents, StepperSlots> {}
export {}