Visualize Your Ideas With Code
docs: minor fixes for custom components (#323)
Jacobdbfb0cb465df
diff --git a/packages/docs/docs/advanced/custom-components.mdx b/packages/docs/docs/advanced/custom-components.mdxindex 705c1216..721bb90f 100644--- a/packages/docs/docs/advanced/custom-components.mdx+++ b/packages/docs/docs/advanced/custom-components.mdx@@ -4,14 +4,14 @@ slug: /custom-componentsimport AnimationPlayer from '@site/src/components/AnimationPlayer';import CodeBlock from '@theme/CodeBlock';-import source from '!!raw-loader!@motion-canvas/examples/src/scenes/components-switch';+import source from '!!raw-loader!@motion-canvas/examples/src/components/Switch';# Components<AnimationPlayer name="components" banner />-Components are classes like [Rect](/api/2d/components/Rect) and-[Circle](/api/2d/component/Rect) that can abstract rendering and data+Components are classes like [`Rect`](/api/2d/components/Rect) and+[`Circle`](/api/2d/components/Circle) that can abstract rendering and datafunctionality into reusable, modular pieces. To use a component in a scene, addit to the view and provide arguments to the component.@@ -21,7 +21,7 @@ it to the view and provide arguments to the component.To define what arguments a component will take, first define an interface. Allproperties of the interface must be wrapped in-[SignalValue<>](/api/core/signals#SignalValue) as such:+[`SignalValue<>`](/api/core/signals#SignalValue) as such:```tsx// You can extend an existing props interface@@ -32,7 +32,7 @@ properties of the interface must be wrapped inexport interface SwitchProps extends NodeProps {initialState?: SignalValue<boolean>;- // We dont use color here because we want+ // We don't use color here because we want// to be able to pass hex strings and rgb// values to accent rather than a `Color`accent?: SignalValue<PossibleColor>;@@ -40,18 +40,22 @@ export interface SwitchProps extends NodeProps {```Next, create a class for your components. The component class must extend-[Node](/api/2d/components/Node) or one of its subclasses. If you dont want to+[`Node`](/api/2d/components/Node) or one of its subclasses. If you don't want toinherit any methods from an existing component, extend your class from `Node`.We advise extending from the component most similar to the component you arebuilding. For instance, if you were to make a component including a-[Layout](/api/2d/components/Layout), you should extend-[Layout](/api/2d/components/Layout) and-[LayoutProps](/api/2d/components/LayoutProps).+[`Layout`](/api/2d/components/Layout), you should extend+[`Layout`](/api/2d/components/Layout) and+[`LayoutProps`](/api/2d/components/LayoutProps).```tsx-export interface SwitchProps extends NodeProps { ... }+export interface SwitchProps extends NodeProps {+ // properties+}-export class Switch extends Node { ... }+export class Switch extends Node {+ // implementation+}```To use the properties defined in the interface, your class _must_ contain a@@ -63,21 +67,21 @@ Here is an example of how you would define such properties:```tsxexport class Switch extends Node {- // @initial - optional, sets the property to an- // initial value if it was not provided.- // The @initial decorator is optional.- @initial(false)- // @signal - is required by motion canvas- // for every prop that was passed in.- @signal()- public declare readonly initialState: SimpleSignal<boolean, this>-- @initial("#68ABDF")- @signal()- public declare readonly accent: ColorSignal<this>-- ...-+ // @initial - optional, sets the property to an+ // initial value if it was not provided.+ @initial(false)+ // @signal - is required by motion canvas+ // for every prop that was passed in.+ @signal()+ public declare readonly initialState: SimpleSignal<boolean, this>;++ @initial('#68ABDF')+ // @colorSignal - some complex types provide a dedicated decorator for+ // signals that takes care of parsing.+ // In this case, `accent` will automatically convert strings into `Color`s+ @colorSignal()+ public declare readonly accent: ColorSignal<this>;+ // ...}```@@ -91,20 +95,21 @@ register the signal to the class. Properties must be initialised with theNormal properties can be defined as normal. For example:```tsx-public constructor(props?: SwitchProps) {+export class Switch extends Node {+ public constructor(props?: SwitchProps) {super({- // If you wanted to ensure that layout was always- // true for this component, you could add it here- // as such:-- //layout: true- ...props- })- ...+ // If you wanted to ensure that layout was always+ // true for this component, you could add it here+ // as such:+ // layout: true+ ...props,+ });+ // ...+ }}```-The `props` parameter can also be useful outside of the `super()` call to access+The `props` parameter can also be useful outside the `super()` call to accessyour data elsewhere. For example, if you were building a component to display anarray, you could use props to set the color of every[Rect](/api/2d/components/Rect) in the array.@@ -113,19 +118,15 @@ Now we can add elements to the view by using `this.add()`, much like you wouldadd to a scene's view:```tsx-public constructor(props?: SwitchProps) {-- ...-+export class Switch extends Node {+ public constructor(props?: SwitchProps) {+ // ...this.add(- <Rect- ...- >- <Circle- ...- />- </Rect>- )+ <Rect>+ <Circle />+ </Rect>,+ );+ }}```@@ -134,17 +135,19 @@ wanting to animate a component easily. Here is an example of a method fortoggling our switch:```tsx-public* toggle(Duration: number) {+export class Switch extends Node {+ // ...+ public *toggle(duration: number) {yield* all(- tween(Duration, value => {- ...- }),-- tween(Duration, value => {- ...- })- )- this.isOn = !this.isOn+ tween(duration, value => {+ // ...+ }),+ tween(duration, value => {+ // ...+ }),+ );+ this.isOn = !this.isOn;+ }}```diff --git a/packages/examples/src/scenes/components-switch.tsx b/packages/examples/src/components/Switch.tsxsimilarity index 91%rename from packages/examples/src/scenes/components-switch.tsxrename to packages/examples/src/components/Switch.tsxindex d585e9f6..c95fd7c3 100644--- a/packages/examples/src/scenes/components-switch.tsx+++ b/packages/examples/src/components/Switch.tsx@@ -5,7 +5,7 @@ import {ColorSignal,PossibleColor,} from '@motion-canvas/core/lib/types/Color';-import {initial, signal} from '@motion-canvas/2d/lib/decorators';+import {colorSignal, initial, signal} from '@motion-canvas/2d/lib/decorators';import {createSignal,SignalValue,@@ -25,7 +25,7 @@ export class Switch extends Node {public declare readonly initialState: SimpleSignal<boolean, this>;@initial('#68ABDF')- @signal()+ @colorSignal()public declare readonly accent: ColorSignal<this>;private isOn: boolean;@@ -59,9 +59,9 @@ export class Switch extends Node {);}- public *toggle(Duration: number) {+ public *toggle(duration: number) {yield* all(- tween(Duration, value => {+ tween(duration, value => {const oldColor = this.isOn ? this.accent() : this.offColor;const newColor = this.isOn ? this.offColor : this.accent();@@ -70,7 +70,7 @@ export class Switch extends Node {);}),- tween(Duration, value => {+ tween(duration, value => {const currentPos = this.indicator().position();this.indicatorPosition(diff --git a/packages/examples/src/scenes/components.tsx b/packages/examples/src/scenes/components.tsxindex b621702d..8c00f941 100644--- a/packages/examples/src/scenes/components.tsx+++ b/packages/examples/src/scenes/components.tsx@@ -1,7 +1,7 @@import {makeScene2D} from '@motion-canvas/2d/lib/scenes';-import {chain, loop, waitFor} from '@motion-canvas/core/lib/flow';+import {waitFor} from '@motion-canvas/core/lib/flow';import {createRef} from '@motion-canvas/core/lib/utils';-import {Switch} from '@motion-canvas/examples/src/scenes/components-switch';+import {Switch} from '@motion-canvas/examples/src/components/Switch';// see this import for the component ^// usage of the component:@@ -10,8 +10,8 @@ export default makeScene2D(function* (view) {view.add(<Switch ref={switchRef} initialState={true} />);- yield* switchRef().toggle(0.2);+ yield* switchRef().toggle(0.6);yield* waitFor(1);- yield* switchRef().toggle(0.2);+ yield* switchRef().toggle(0.6);yield* waitFor(1);});