1.11.7 • Published 9 months ago

@tscircuit/builder v1.11.7

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

@tscircuit/builder

tscircuit docs · github · tscircuit · discord · builder reference docs

TSCircuit Builder is a Typescript builder pattern for constructing schematic and PCB layouts. @tscircuit/builder is an internal module, use tscircuit tsx instead. The builder is basically "the DOM for building circuits"

TSCircuit TSX eventually renders to a builder. The builder will build TSCircuit Soup, a JSON output. Soup can be rendered to a webpage as either a schematic or PCB layout.

!NOTE Why not go directly from TSX -> Schematic/PCB?

If you think about how React works, there's a layer between React and the rendered HTML image you see on your screen, that layer is the DOM. The DOM simplifies the amount of work React has to do. In the same way, the Builder simplifies the amount of work that the TSCircuit TSX have to do while providing a lot of flexibility for different renderers. It's like the DOM for Circuits.

!NOTE

@tscircuit/builder is going to be replaced by @tscircuit/core eventually, the API and types are a bit wrong because it's an old package. Try to use React with tscircuit to avoid building on the builder API (tscircuit React has a much more permanent API)

Example

const projectBuilder = await createProjectBuilder()
  .add("resistor", (rb) =>
    rb
      .setProps({
        resistance: "10 ohm",
        name: "R1",
        schX: 2,
        schY: 1
      })
  )

const projectBuilderOutput = await projectBuilder.build()


/*
// Soup JSON, very verbose! Looks easy to render though!
[
  {
    ftype: 'simple_resistor',
    name: 'R1',
    resistance: '10 ohm',
    source_component_id: 'simple_resistor_0',
    type: 'source_component',
  },
  {
    center: {
      x: 2,
      y: 1,
    },
    rotation: 0,
    schematic_component_id: 'schematic_component_simple_resistor_0',
    size: {
      height: 0.3,
      width: 1,
    },
    source_component_id: 'simple_resistor_0',
    type: 'schematic_component',
  },
  ...
]

Installation

npm install --save @tscircuit/builder
@lume/kiwi@tscircuit/layout@tscircuit/routing@tscircuit/schematic-autolayoutcircuit-json-to-gerberconvert-unitsfast-json-stable-stringifyformat-si-prefixpapaparserectilinear-routersvg-path-boundstransformation-matrix
@everything-registry/sub-chunk-938kicad-mod-convertertscircuit-cli@tscircuit/kicad-mod-converter
1.11.4

10 months ago

1.11.3

10 months ago

1.11.7

9 months ago

1.11.6

10 months ago

1.11.5

10 months ago

1.11.2

10 months ago

1.11.1

10 months ago

1.11.0

10 months ago

1.10.0

10 months ago

1.9.6

10 months ago

1.9.5

10 months ago

1.9.4

10 months ago

1.9.3

10 months ago

1.9.2

10 months ago

1.9.1

10 months ago

1.9.0

11 months ago

1.8.2

11 months ago

1.8.1

11 months ago

1.8.0

11 months ago

1.6.0

11 months ago

1.5.155

11 months ago

1.7.0

11 months ago

1.5.119

1 year ago

1.5.118

1 year ago

1.5.117

1 year ago

1.5.116

1 year ago

1.5.126

12 months ago

1.5.125

12 months ago

1.5.124

12 months ago

1.5.123

12 months ago

1.5.122

12 months ago

1.5.121

1 year ago

1.5.120

1 year ago

1.5.109

1 year ago

1.5.108

1 year ago

1.5.107

1 year ago

1.5.106

1 year ago

1.5.105

1 year ago

1.5.115

1 year ago

1.5.114

1 year ago

1.5.113

1 year ago

1.5.112

1 year ago

1.5.111

1 year ago

1.5.110

1 year ago

1.5.104

1 year ago

1.5.103

1 year ago

1.5.102

1 year ago

1.5.96

1 year ago

1.5.101

1 year ago

1.5.100

1 year ago

1.5.98

1 year ago

1.5.97

1 year ago

1.5.99

1 year ago

1.5.149

11 months ago

1.5.154

11 months ago

1.5.153

11 months ago

1.5.152

11 months ago

1.5.151

11 months ago

1.5.150

11 months ago

1.5.139

11 months ago

1.5.138

11 months ago

1.5.148

11 months ago

1.5.147

11 months ago

1.5.146

11 months ago

1.5.145

11 months ago

1.5.144

11 months ago

1.5.143

11 months ago

1.5.142

11 months ago

1.5.141

11 months ago

1.5.140

11 months ago

1.5.129

12 months ago

1.5.128

12 months ago

1.5.127

12 months ago

1.5.137

11 months ago

1.5.136

11 months ago

1.5.135

12 months ago

1.5.134

12 months ago

1.5.133

12 months ago

1.5.132

12 months ago

1.5.131

12 months ago

1.5.130

12 months ago

1.5.94

1 year ago

1.5.93

1 year ago

1.5.95

1 year ago

1.5.92

1 year ago

1.5.91

1 year ago

1.5.90

1 year ago

1.5.89

1 year ago

1.5.88

1 year ago

1.5.87

1 year ago

1.5.86

1 year ago

1.5.81

1 year ago

1.5.80

1 year ago

1.5.83

1 year ago

1.5.82

1 year ago

1.5.85

1 year ago

1.5.84

1 year ago

1.5.78

1 year ago

1.5.79

1 year ago

1.5.76

1 year ago

1.5.77

1 year ago

1.5.75

1 year ago

1.5.74

1 year ago

1.5.73

1 year ago

1.5.72

1 year ago

1.5.71

1 year ago

1.5.70

1 year ago

1.5.67

1 year ago

1.5.66

1 year ago

1.5.69

1 year ago

1.5.68

1 year ago

1.5.63

1 year ago

1.5.62

1 year ago

1.5.65

1 year ago

1.5.64

1 year ago

1.5.59

1 year ago

1.5.61

1 year ago

1.5.60

1 year ago

1.5.56

1 year ago

1.5.55

1 year ago

1.5.58

1 year ago

1.5.57

1 year ago

1.5.54

1 year ago

1.5.52

1 year ago

1.5.53

1 year ago

1.5.50

1 year ago

1.5.51

1 year ago

1.5.47

1 year ago

1.5.49

1 year ago

1.5.48

1 year ago

1.5.46

1 year ago

1.5.43

1 year ago

1.5.42

1 year ago

1.5.45

1 year ago

1.5.44

1 year ago

1.5.41

1 year ago

1.5.38

1 year ago

1.5.39

1 year ago

1.5.40

1 year ago

1.5.37

1 year ago

1.5.36

1 year ago

1.5.30

1 year ago

1.5.32

1 year ago

1.5.31

1 year ago

1.5.34

1 year ago

1.5.33

1 year ago

1.5.35

1 year ago

1.5.23

1 year ago

1.5.22

1 year ago

1.5.25

1 year ago

1.5.24

1 year ago

1.5.27

1 year ago

1.5.26

1 year ago

1.5.29

1 year ago

1.5.28

1 year ago

1.5.14

1 year ago

1.5.16

1 year ago

1.5.15

1 year ago

1.5.18

1 year ago

1.5.17

1 year ago

1.5.19

1 year ago

1.5.21

1 year ago

1.5.20

1 year ago

1.5.13

1 year ago

1.5.12

1 year ago

1.5.11

1 year ago

1.5.9

1 year ago

1.5.8

1 year ago

1.5.7

1 year ago

1.5.10

1 year ago

1.5.6

1 year ago

1.5.5

1 year ago

1.2.0

2 years ago

1.2.8

2 years ago

1.2.7

2 years ago

1.2.6

2 years ago

1.4.3

2 years ago

1.2.5

2 years ago

1.4.2

2 years ago

1.2.4

2 years ago

1.4.1

2 years ago

1.2.3

2 years ago

1.4.0

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.2.12

2 years ago

1.2.13

2 years ago

1.2.10

2 years ago

1.2.11

2 years ago

1.2.16

2 years ago

1.2.17

2 years ago

1.2.14

2 years ago

1.2.15

2 years ago

1.2.18

2 years ago

1.2.19

2 years ago

1.5.4

2 years ago

1.5.3

2 years ago

1.5.2

2 years ago

1.3.4

2 years ago

1.5.1

2 years ago

1.3.3

2 years ago

1.5.0

2 years ago

1.3.2

2 years ago

1.3.1

2 years ago

1.3.0

2 years ago

1.1.2

2 years ago

1.2.20

2 years ago

1.2.23

2 years ago

1.2.21

2 years ago

1.2.22

2 years ago

1.2.9

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.12

2 years ago

1.0.9

3 years ago

1.0.8

3 years ago

1.0.7

3 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.11

3 years ago

1.0.10

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

0.0.1

3 years ago