svelte-tweakpane-ui/dist/internal/InternalMonitorBoolean.svelte.d.ts

A Svelte component library wrapping UI elements from Tweakpane, plus some additional functionality for convenience and flexibility.

import { SvelteComponent } from 'svelte'
import type { BooleanMonitorParams } from '@tweakpane/core'
export type InternalMonitorBooleanOptions = BooleanMonitorParams
declare const __propDef: {
	props: Omit<
		Omit<
			{
				/**
				 * The binding's target object with values to manipulate.
				 *
				 * @bindable
				 */
				object: import('@tweakpane/core').Bindable & Record<string, boolean>
				/**
				 * 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?: BooleanMonitorParams | undefined
				/**
				 * Custom color scheme.
				 *
				 * If undefined, inherits default Tweakpane theme equivalent to
				 * `ThemeUtils.presets.standard`, or the theme set with
				 * `setGlobalDefaultTheme()`.
				 *
				 * @default `undefined`
				 */
				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?: import('./GenericMonitor.svelte').GenericMonitorRef | 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'
		> & {
			/**
			 * A `boolean` value to monitor.
			 */
			value: boolean
		} & {
			/**
			 * Number of past states to retain.
			 *
			 * If value is `number` and `graph` is `true`, default value is `64`.
			 *
			 * @default `1`
			 */
			bufferSize?: number
			/**
			 * Time between value samples in milliseconds.
			 *
			 * Useful when `graph` is true. Defaults to reactive value updates only
			 * (`interval={0}`).
			 *
			 * @default `0`
			 */
			interval?: number
			/**
			 * Number of visible rows of state history.
			 *
			 * If `bufferSize` is larger, then the value window will scroll once state
			 * history exceeds row count.
			 *
			 * If value is `string` and `multiline` is `true`, default value is `3`.
			 *
			 * @default `1`
			 */
			rows?: number
		},
		'ref' | 'options' | 'plugin' | 'interval'
	> & {
		/**
		 * A `boolean` value to monitor.
		 */
		value: boolean
	}
	events: {
		[evt: string]: CustomEvent<any>
	}
	slots: {}
	exports?: {} | undefined
	bindings?: string | undefined
}
export type InternalMonitorBooleanProps = typeof __propDef.props
export type InternalMonitorBooleanEvents = typeof __propDef.events
export type InternalMonitorBooleanSlots = typeof __propDef.slots
/**
 * This component is for internal use only.
 *
 * Documentation retained in case of a return to the non-dynamic component approach.
 *
 * Wraps the Tweakpane [monitor binding](https://tweakpane.github.io/docs/monitor-bindings/)
 * functionality for boolean values.
 *
 * Technically, any unbound value on a normal _Svelte Tweakpane UI_ component effectively acts as a
 * monitor, but additional monitor-specific components are provided to expose additional view options
 * (e.g. `rows`).
 *
 * Note that `interval` is not exposed because updates are driven by reactive changes in the `value`.
 *
 * Usage outside of a `<Pane>` component will implicitly wrap the monitor in a `<Pane
 * position="inline">` component.
 *
 * @example
 * ```svelte
 * <script lang="ts">
 * import { InternalMonitorBoolean } from 'svelte-tweakpane-ui'
 *
 * let booleanToMonitor = false
 *
 * setInterval(() => {
 *   booleanToMonitor = Math.random() > 0.5
 * }, 100)
 * </script>
 *
 * <InternalMonitorBoolean value={booleanToMonitor} bufferSize={5} rows={5} />
 * ```
 *
 * @sourceLink
 * [InternalMonitorBoolean.svelte](https://github.com/kitschpatrol/svelte-tweakpane-ui/blob/main/src/lib/internal/InternalMonitorBoolean.svelte)
 */
export default class InternalMonitorBoolean extends SvelteComponent<
	InternalMonitorBooleanProps,
	InternalMonitorBooleanEvents,
	InternalMonitorBooleanSlots
> {}
export {}