@tscircuit/props 0.0.115 → 0.0.116
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ This repo contains all the prop definitions and zod parsers for tscircuit builti
|
|
|
4
4
|
`<capacitor />` etc.
|
|
5
5
|
|
|
6
6
|
This repo is the source-of-truth for defining the React props, API changes begin here. The focus of the API is on ergonomics for
|
|
7
|
-
the user (unlike [
|
|
7
|
+
the user (unlike [circuit-json](https://github.com/tscircuit/circuit-json) which focuses on ergonomics for a renderer)
|
|
8
8
|
|
|
9
9
|
```ts
|
|
10
10
|
import type { ResistorProps, ResistorPropsInput } from "@tscircuit/props"
|
|
@@ -13,21 +13,3 @@ import { resistorProps } from "@tscircuit/props"
|
|
|
13
13
|
resistorProps.parse({ resistance: "10k" } as ResistorPropsInput)
|
|
14
14
|
// { resistance: 10_000 }
|
|
15
15
|
```
|
|
16
|
-
|
|
17
|
-
This module is used in the [builder](https://github.com/tscircuit/builder) as well as the [react-fiber layer](https://github.com/tscircuit/react-fiber)
|
|
18
|
-
to keep prop definitions in-sync.
|
|
19
|
-
|
|
20
|
-
tscircuit has a convention of React code being `camelCase` and internal or backend code being `snake_case`, this library can function
|
|
21
|
-
to transition between the two types.
|
|
22
|
-
|
|
23
|
-
```ts
|
|
24
|
-
bugProps.parse({
|
|
25
|
-
portArrangement: {}
|
|
26
|
-
})
|
|
27
|
-
// { portArrangement: { } }
|
|
28
|
-
|
|
29
|
-
bug_props_u.parse({
|
|
30
|
-
portArrangement: {}
|
|
31
|
-
})
|
|
32
|
-
// { port_arrangement: { } }
|
|
33
|
-
```
|