Skip to content

Commit

Permalink
Docs: Minor cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
kitschpatrol committed Dec 30, 2023
1 parent 7082dc9 commit cfadfde
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/src/content/docs/docs/features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Pane titles and blade labels are truncated with ellipses if they're too long to

Certain aspects of the Tweakpane API don't make a ton of sense in the Svelte context, and have been removed or hidden from the API.

### Custom container
### Custom containers

The [`container`](https://tweakpane.github.io/docs/misc/#container) [PaneConfig](https://tweakpane.github.io/docs/api/interfaces/_internal_.PaneConfig.html) option is not exposed, because correct placement in the containing DOM is managed by _Svelte Tweakpane UI_, and `<Pane position='inline' ...>` may be used where you'd like a pane to become part of the normal document flow.

Expand Down
1 change: 0 additions & 1 deletion src/lib/control/ButtonGrid.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@
export let label: $$Props['label'] = undefined;
// Seems to be the only way to get event comments to work eslint-disable-next-line
// @typescript-eslint/no-unused-vars
type $$Events = {
/**
* Fires when a button is clicked.
Expand Down
2 changes: 1 addition & 1 deletion src/lib/control/Point.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
: unknown;
// Some redefinition of props from GenericSlider, but redefining since we want to refine the
// documentation anyway eslint-disable-next-line @typescript-eslint/no-unused-vars
// documentation anyway
type $$Props = Omit<
ComponentProps<GenericInputFolding<T, PointOptions<T>>>,
'buttonClass' | 'options' | 'plugin' | 'ref'
Expand Down
3 changes: 1 addition & 2 deletions src/lib/extra/AutoValue.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ A (reasonably) appropriate Tweakpane control will be used for the value type.
This component is intended for quick tests where you don't want to fuss with component selection or
customization.
See `<AutoObject>` for a variation that works directly on a stand-alone value that isn't wrapped in
an object.
See `<AutoObject>` for a variation that creates controls for multiple values in an object.
The value is generally mapped to controls according to the logic outlined in the [Tweakpane input
binding documentation](https://tweakpane.github.io/docs/input-bindings/).
Expand Down
2 changes: 1 addition & 1 deletion src/lib/extra/Element.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ This component does not have a direct analog in the vanilla Tweakpane universe.
Think of `<Element>` as an escape hatch for getting something into the pane that
you couldn't otherwise. Generally, it's recommended to abstract new
functionality for reuse by extending one of the internal component types in
'svelte-tweakpane-ui', or better yet by creating a new [Tweakpane
Svelte Tweakpane UI, or better yet by creating a new [Tweakpane
Plugin](https://github.com/tweakpane/plugin-template) — but sometimes you just
need to get something into the pane quickly.
Expand Down
3 changes: 2 additions & 1 deletion src/lib/internal/GenericSlider.svelte
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<script generics="T extends number | IntervalSliderValue" lang="ts">
import GenericInput from '$lib/internal/GenericInput.svelte'; // eslint-disable-next-line @typescript-eslint/no-unused-vars
// eslint-disable-next-line @typescript-eslint/no-unused-vars
import type { IntervalSliderValue } from '$lib/control/IntervalSlider.svelte';
import GenericInput from '$lib/internal/GenericInput.svelte';
import type { ComponentProps } from 'svelte';
import type { NumberInputParams as GenericSliderOptions } from 'tweakpane';
import type { SliderInputBindingApi as GenericSliderRef } from 'tweakpane';
Expand Down

0 comments on commit cfadfde

Please sign in to comment.