schematic-symbols 0.0.25 → 0.0.27

package/README.md

@@ -4,6 +4,9 @@
 
 Schematic symbols for tscircuit
 
+> [!TIP]
+> Looking to contribute to this repo? Take a look at [How to Contribute to Schematic Symbols](https://blog.tscircuit.com/p/how-to-contribute-to-schematic-symbols)!
+
 ## Usage
 
 ```ts
@@ -15,7 +18,7 @@ console.log(symbols.resistor.size)
 // { width: 1, height: 0.6 }
 
 getSvg(resistor)
-// <svg><path d="M0 0L1 0... ...</svg>
+// <svg><path d="M0 0L1 0... ..."</svg>
 
 // You can easily resize symbols
 console.log(resize(symbols.resistor, { width: 100 }).size)
@@ -24,9 +27,12 @@ console.log(resize(symbols.resistor, { width: 100 }).size)
 
 ## Adding New Symbols
 
-Go into the `./symbols` directory to add new shapes. After adding a shape file, it will
-automatically appear in the dev environment (`npm run dev`). Here's an example of a shape
-file:
+1. Add a new svg file to the `./assets/symbols` directory (copy volt_meter.svg to a new file named `<symbol_name>.svg`)
+2. Run `bun run generate` to generate the new symbol
+3. Run `bun run dev` to start the dev server and verify the new symbol
+4. Run `bun run build` to build all the symbols into the `./generated` directory
+
+Here's an example of a generated symbol file:
 
 ```ts
 // boxresistor.ts
@@ -46,6 +52,8 @@ export const boxresistor = defineSymbol({
 })
 ```
 
+> These files are used to generate an
+
 ### Primitives
 
 Various primitive JSON elements are defined to represent components, each primitive has
@@ -77,6 +85,7 @@ in the same schematic.
 ### Development
 
 Software needed to edit this project:
+
 - VS Code
 - Inkscape
 

package/dist/index.d.ts

@@ -11,6 +11,8 @@ declare const _default: {
     led_vert: undefined;
     mosfet_depletion_normally_on_horz: undefined;
     mosfet_depletion_normally_on_vert: undefined;
+    photodiode_horz: undefined;
+    photodiode_vert: undefined;
     potentiometer_horz: undefined;
     potentiometer_vert: undefined;
     potentiometer2_horz: undefined;
@@ -19,8 +21,12 @@ declare const _default: {
     push_button_normally_closed_momentary_vert: undefined;
     push_button_normally_open_momentary_horz: undefined;
     push_button_normally_open_momentary_vert: undefined;
+    schottky_diode_horz: undefined;
+    schottky_diode_vert: undefined;
     varistor_horz: undefined;
     varistor_vert: undefined;
+    volt_meter_horz: undefined;
+    volt_meter_vert: undefined;
 };
 
 interface Point {
@@ -52,6 +58,8 @@ interface CirclePrimitive {
     x: number;
     y: number;
     radius: number;
+    fill: boolean;
+    color: string;
 }
 interface BoxPrimitive {
     type: "box";
@@ -89,7 +97,7 @@ declare function resizeSymbol(symbol: SchSymbol, newSize: {
     height?: number;
 }): SchSymbol;
 
-type BaseSymbolName = "boxresistor | capacitor | diode | fuse | led | mosfet_depletion_normally_on | potentiometer | potentiometer2 | push_button_normally_closed_momentary | push_button_normally_open_momentary | varistor";
+type BaseSymbolName = "boxresistor | capacitor | diode | fuse | led | mosfet_depletion_normally_on | photodiode | potentiometer | potentiometer2 | push_button_normally_closed_momentary | push_button_normally_open_momentary | schottky_diode | varistor | volt_meter";
 
 /**
  * Utility for easier autocomplete: