Skip to content

Commit

Permalink
Minor doc rephrasings.
Browse files Browse the repository at this point in the history
  • Loading branch information
kitschpatrol committed Dec 17, 2023
1 parent a0e9d75 commit ce4feb5
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/src/components/docs/DynamicPropAdmonition.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Flags from './Flags.astro';

:::note[Dynamic Props]

**This component has dynamic props, which means the props available on the component can change depending on the value or type of _other_ props passed to the component.**
**This component has dynamic props, which means the available props can change depending on the value or type of _other_ props.**

Props contingent on certain conditions are annotated below with a <Flags names={["dynamic"]} /> flag, and include explanations of the "conditions" affecting the prop's availability. [More Info&thinsp;](/svelte-tweakpane-ui/docs#dynamic-props)
:::
2 changes: 1 addition & 1 deletion docs/src/content/docs/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Import and use Tweakpane components in your `.svelte` files:
import { Button } from 'svelte-tweakpane-ui';
</script>
<Button on:click={() => alert('Hi from STUI')} />
<Button on:click={() => alert('🎛️')} />
```

---
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

The library makes it easy to quickly and declaratively add knobs and dials to your projects using components that feel like they were made for Svelte. It also augments Tweakpane with a few [extra features](https://kitschpatrol.com/svelte-tweakpane-ui/docs/features) for your convenience and enjoyment.

[The components](https://kitschpatrol.com/svelte-tweakpane-ui/docs#components) should be useful for integrating controls and value monitoring in parametrically driven artworks or simulations.
[The components](https://kitschpatrol.com/svelte-tweakpane-ui/docs#components) should be useful for integrating controls and value monitoring in parametrically driven artworks, data visualizations, creative tools, simulations, etc.

## Demo

Expand Down

0 comments on commit ce4feb5

Please sign in to comment.