@tscircuit/props 0.0.559 → 0.0.560

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.
Files changed (6) hide show
  1. package/README.md +5 -0
  2. package/dist/index.d.ts +40 -0
  3. package/dist/index.js +1 -0
  4. package/dist/index.js.map +1 -1
  5. package/lib/components/group.ts +9 -0
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -801,6 +801,11 @@ export interface BaseGroupProps extends CommonLayoutProps, LayoutConfig {
801
801
  */
802
802
  schTitle?: string;
803
803
 
804
+ /**
805
+ * This group will be drawn as part of this sheet e.g. "Main"
806
+ */
807
+ schSheetName?: string;
808
+
804
809
  /**
805
810
  * If true, render this group as a single schematic box
806
811
  */
package/dist/index.d.ts CHANGED
@@ -17739,6 +17739,10 @@ interface BaseGroupProps extends CommonLayoutProps, LayoutConfig {
17739
17739
  * Title to display above this group in the schematic view
17740
17740
  */
17741
17741
  schTitle?: string;
17742
+ /**
17743
+ * This group will be drawn as part of this sheet e.g. "Main"
17744
+ */
17745
+ schSheetName?: string;
17742
17746
  /**
17743
17747
  * If true, render this group as a single schematic box
17744
17748
  */
@@ -18398,6 +18402,7 @@ declare const baseGroupProps: z.ZodObject<{
18398
18402
  name: z.ZodOptional<z.ZodString>;
18399
18403
  children: z.ZodOptional<z.ZodAny>;
18400
18404
  schTitle: z.ZodOptional<z.ZodString>;
18405
+ schSheetName: z.ZodOptional<z.ZodString>;
18401
18406
  key: z.ZodOptional<z.ZodAny>;
18402
18407
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
18403
18408
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -18606,6 +18611,7 @@ declare const baseGroupProps: z.ZodObject<{
18606
18611
  } | undefined;
18607
18612
  schRelative?: boolean | undefined;
18608
18613
  children?: any;
18614
+ schSheetName?: string | undefined;
18609
18615
  grid?: boolean | undefined;
18610
18616
  flex?: string | boolean | undefined;
18611
18617
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -18865,6 +18871,7 @@ declare const baseGroupProps: z.ZodObject<{
18865
18871
  } | undefined;
18866
18872
  schRelative?: boolean | undefined;
18867
18873
  children?: any;
18874
+ schSheetName?: string | undefined;
18868
18875
  grid?: boolean | undefined;
18869
18876
  flex?: string | boolean | undefined;
18870
18877
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -19471,6 +19478,7 @@ declare const subcircuitGroupProps: z.ZodObject<{
19471
19478
  name: z.ZodOptional<z.ZodString>;
19472
19479
  children: z.ZodOptional<z.ZodAny>;
19473
19480
  schTitle: z.ZodOptional<z.ZodString>;
19481
+ schSheetName: z.ZodOptional<z.ZodString>;
19474
19482
  key: z.ZodOptional<z.ZodAny>;
19475
19483
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
19476
19484
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -19888,6 +19896,7 @@ declare const subcircuitGroupProps: z.ZodObject<{
19888
19896
  } | undefined;
19889
19897
  schRelative?: boolean | undefined;
19890
19898
  children?: any;
19899
+ schSheetName?: string | undefined;
19891
19900
  grid?: boolean | undefined;
19892
19901
  flex?: string | boolean | undefined;
19893
19902
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -20207,6 +20216,7 @@ declare const subcircuitGroupProps: z.ZodObject<{
20207
20216
  } | undefined;
20208
20217
  schRelative?: boolean | undefined;
20209
20218
  children?: any;
20219
+ schSheetName?: string | undefined;
20210
20220
  grid?: boolean | undefined;
20211
20221
  flex?: string | boolean | undefined;
20212
20222
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -20874,6 +20884,7 @@ declare const subcircuitGroupPropsWithBool: z.ZodObject<{
20874
20884
  name: z.ZodOptional<z.ZodString>;
20875
20885
  children: z.ZodOptional<z.ZodAny>;
20876
20886
  schTitle: z.ZodOptional<z.ZodString>;
20887
+ schSheetName: z.ZodOptional<z.ZodString>;
20877
20888
  key: z.ZodOptional<z.ZodAny>;
20878
20889
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
20879
20890
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -21294,6 +21305,7 @@ declare const subcircuitGroupPropsWithBool: z.ZodObject<{
21294
21305
  } | undefined;
21295
21306
  schRelative?: boolean | undefined;
21296
21307
  children?: any;
21308
+ schSheetName?: string | undefined;
21297
21309
  grid?: boolean | undefined;
21298
21310
  flex?: string | boolean | undefined;
21299
21311
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -21614,6 +21626,7 @@ declare const subcircuitGroupPropsWithBool: z.ZodObject<{
21614
21626
  } | undefined;
21615
21627
  schRelative?: boolean | undefined;
21616
21628
  children?: any;
21629
+ schSheetName?: string | undefined;
21617
21630
  grid?: boolean | undefined;
21618
21631
  flex?: string | boolean | undefined;
21619
21632
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -22286,6 +22299,7 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
22286
22299
  name: z.ZodOptional<z.ZodString>;
22287
22300
  children: z.ZodOptional<z.ZodAny>;
22288
22301
  schTitle: z.ZodOptional<z.ZodString>;
22302
+ schSheetName: z.ZodOptional<z.ZodString>;
22289
22303
  key: z.ZodOptional<z.ZodAny>;
22290
22304
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
22291
22305
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -22496,6 +22510,7 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
22496
22510
  } | undefined;
22497
22511
  schRelative?: boolean | undefined;
22498
22512
  children?: any;
22513
+ schSheetName?: string | undefined;
22499
22514
  grid?: boolean | undefined;
22500
22515
  flex?: string | boolean | undefined;
22501
22516
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -22756,6 +22771,7 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
22756
22771
  } | undefined;
22757
22772
  schRelative?: boolean | undefined;
22758
22773
  children?: any;
22774
+ schSheetName?: string | undefined;
22759
22775
  grid?: boolean | undefined;
22760
22776
  flex?: string | boolean | undefined;
22761
22777
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -23361,6 +23377,7 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
23361
23377
  name: z.ZodOptional<z.ZodString>;
23362
23378
  children: z.ZodOptional<z.ZodAny>;
23363
23379
  schTitle: z.ZodOptional<z.ZodString>;
23380
+ schSheetName: z.ZodOptional<z.ZodString>;
23364
23381
  key: z.ZodOptional<z.ZodAny>;
23365
23382
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
23366
23383
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -23781,6 +23798,7 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
23781
23798
  } | undefined;
23782
23799
  schRelative?: boolean | undefined;
23783
23800
  children?: any;
23801
+ schSheetName?: string | undefined;
23784
23802
  grid?: boolean | undefined;
23785
23803
  flex?: string | boolean | undefined;
23786
23804
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -24101,6 +24119,7 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
24101
24119
  } | undefined;
24102
24120
  schRelative?: boolean | undefined;
24103
24121
  children?: any;
24122
+ schSheetName?: string | undefined;
24104
24123
  grid?: boolean | undefined;
24105
24124
  flex?: string | boolean | undefined;
24106
24125
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -24799,6 +24818,7 @@ declare const boardProps: z.ZodObject<Omit<{
24799
24818
  name: z.ZodOptional<z.ZodString>;
24800
24819
  children: z.ZodOptional<z.ZodAny>;
24801
24820
  schTitle: z.ZodOptional<z.ZodString>;
24821
+ schSheetName: z.ZodOptional<z.ZodString>;
24802
24822
  key: z.ZodOptional<z.ZodAny>;
24803
24823
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
24804
24824
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -25246,6 +25266,7 @@ declare const boardProps: z.ZodObject<Omit<{
25246
25266
  } | undefined;
25247
25267
  schRelative?: boolean | undefined;
25248
25268
  children?: any;
25269
+ schSheetName?: string | undefined;
25249
25270
  grid?: boolean | undefined;
25250
25271
  flex?: string | boolean | undefined;
25251
25272
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -25581,6 +25602,7 @@ declare const boardProps: z.ZodObject<Omit<{
25581
25602
  } | undefined;
25582
25603
  schRelative?: boolean | undefined;
25583
25604
  children?: any;
25605
+ schSheetName?: string | undefined;
25584
25606
  grid?: boolean | undefined;
25585
25607
  flex?: string | boolean | undefined;
25586
25608
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -26298,6 +26320,7 @@ declare const panelProps: z.ZodObject<Omit<{
26298
26320
  name: z.ZodOptional<z.ZodString>;
26299
26321
  children: z.ZodOptional<z.ZodAny>;
26300
26322
  schTitle: z.ZodOptional<z.ZodString>;
26323
+ schSheetName: z.ZodOptional<z.ZodString>;
26301
26324
  key: z.ZodOptional<z.ZodAny>;
26302
26325
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
26303
26326
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -26528,6 +26551,7 @@ declare const panelProps: z.ZodObject<Omit<{
26528
26551
  } | undefined;
26529
26552
  schRelative?: boolean | undefined;
26530
26553
  children?: any;
26554
+ schSheetName?: string | undefined;
26531
26555
  grid?: boolean | undefined;
26532
26556
  flex?: string | boolean | undefined;
26533
26557
  layoutMode?: "none" | "grid" | "pack" | undefined;
@@ -26804,6 +26828,7 @@ declare const panelProps: z.ZodObject<Omit<{
26804
26828
  } | undefined;
26805
26829
  schRelative?: boolean | undefined;
26806
26830
  children?: any;
26831
+ schSheetName?: string | undefined;
26807
26832
  grid?: boolean | undefined;
26808
26833
  flex?: string | boolean | undefined;
26809
26834
  layoutMode?: "none" | "grid" | "pack" | undefined;
@@ -27434,6 +27459,7 @@ declare const subpanelProps: z.ZodObject<Omit<{
27434
27459
  name: z.ZodOptional<z.ZodString>;
27435
27460
  children: z.ZodOptional<z.ZodAny>;
27436
27461
  schTitle: z.ZodOptional<z.ZodString>;
27462
+ schSheetName: z.ZodOptional<z.ZodString>;
27437
27463
  key: z.ZodOptional<z.ZodAny>;
27438
27464
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
27439
27465
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -27664,6 +27690,7 @@ declare const subpanelProps: z.ZodObject<Omit<{
27664
27690
  } | undefined;
27665
27691
  schRelative?: boolean | undefined;
27666
27692
  children?: any;
27693
+ schSheetName?: string | undefined;
27667
27694
  grid?: boolean | undefined;
27668
27695
  flex?: string | boolean | undefined;
27669
27696
  layoutMode?: "none" | "grid" | "pack" | undefined;
@@ -27940,6 +27967,7 @@ declare const subpanelProps: z.ZodObject<Omit<{
27940
27967
  } | undefined;
27941
27968
  schRelative?: boolean | undefined;
27942
27969
  children?: any;
27970
+ schSheetName?: string | undefined;
27943
27971
  grid?: boolean | undefined;
27944
27972
  flex?: string | boolean | undefined;
27945
27973
  layoutMode?: "none" | "grid" | "pack" | undefined;
@@ -28565,6 +28593,7 @@ declare const breakoutProps: z.ZodObject<{
28565
28593
  name: z.ZodOptional<z.ZodString>;
28566
28594
  children: z.ZodOptional<z.ZodAny>;
28567
28595
  schTitle: z.ZodOptional<z.ZodString>;
28596
+ schSheetName: z.ZodOptional<z.ZodString>;
28568
28597
  key: z.ZodOptional<z.ZodAny>;
28569
28598
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
28570
28599
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -28987,6 +29016,7 @@ declare const breakoutProps: z.ZodObject<{
28987
29016
  } | undefined;
28988
29017
  schRelative?: boolean | undefined;
28989
29018
  children?: any;
29019
+ schSheetName?: string | undefined;
28990
29020
  grid?: boolean | undefined;
28991
29021
  flex?: string | boolean | undefined;
28992
29022
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -29306,6 +29336,7 @@ declare const breakoutProps: z.ZodObject<{
29306
29336
  } | undefined;
29307
29337
  schRelative?: boolean | undefined;
29308
29338
  children?: any;
29339
+ schSheetName?: string | undefined;
29309
29340
  grid?: boolean | undefined;
29310
29341
  flex?: string | boolean | undefined;
29311
29342
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -89137,6 +89168,7 @@ declare const stampboardProps: z.ZodObject<Omit<{
89137
89168
  name: z.ZodOptional<z.ZodString>;
89138
89169
  children: z.ZodOptional<z.ZodAny>;
89139
89170
  schTitle: z.ZodOptional<z.ZodString>;
89171
+ schSheetName: z.ZodOptional<z.ZodString>;
89140
89172
  key: z.ZodOptional<z.ZodAny>;
89141
89173
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
89142
89174
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -89595,6 +89627,7 @@ declare const stampboardProps: z.ZodObject<Omit<{
89595
89627
  } | undefined;
89596
89628
  schRelative?: boolean | undefined;
89597
89629
  children?: any;
89630
+ schSheetName?: string | undefined;
89598
89631
  leftPinCount?: number | undefined;
89599
89632
  rightPinCount?: number | undefined;
89600
89633
  topPinCount?: number | undefined;
@@ -89940,6 +89973,7 @@ declare const stampboardProps: z.ZodObject<Omit<{
89940
89973
  } | undefined;
89941
89974
  schRelative?: boolean | undefined;
89942
89975
  children?: any;
89976
+ schSheetName?: string | undefined;
89943
89977
  leftPinCount?: number | undefined;
89944
89978
  rightPinCount?: number | undefined;
89945
89979
  topPinCount?: number | undefined;
@@ -109333,6 +109367,7 @@ declare const mountedboardProps: z.ZodObject<{
109333
109367
  name: z.ZodOptional<z.ZodString>;
109334
109368
  children: z.ZodOptional<z.ZodAny>;
109335
109369
  schTitle: z.ZodOptional<z.ZodString>;
109370
+ schSheetName: z.ZodOptional<z.ZodString>;
109336
109371
  key: z.ZodOptional<z.ZodAny>;
109337
109372
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
109338
109373
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -109895,6 +109930,7 @@ declare const mountedboardProps: z.ZodObject<{
109895
109930
  schRelative?: boolean | undefined;
109896
109931
  children?: any;
109897
109932
  manufacturerPartNumber?: string | undefined;
109933
+ schSheetName?: string | undefined;
109898
109934
  grid?: boolean | undefined;
109899
109935
  flex?: string | boolean | undefined;
109900
109936
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -110253,6 +110289,7 @@ declare const mountedboardProps: z.ZodObject<{
110253
110289
  schRelative?: boolean | undefined;
110254
110290
  children?: any;
110255
110291
  manufacturerPartNumber?: string | undefined;
110292
+ schSheetName?: string | undefined;
110256
110293
  grid?: boolean | undefined;
110257
110294
  flex?: string | boolean | undefined;
110258
110295
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -120879,6 +120916,7 @@ declare const subcircuitProps: z.ZodObject<{
120879
120916
  name: z.ZodOptional<z.ZodString>;
120880
120917
  children: z.ZodOptional<z.ZodAny>;
120881
120918
  schTitle: z.ZodOptional<z.ZodString>;
120919
+ schSheetName: z.ZodOptional<z.ZodString>;
120882
120920
  key: z.ZodOptional<z.ZodAny>;
120883
120921
  showAsSchematicBox: z.ZodOptional<z.ZodBoolean>;
120884
120922
  connections: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodReadonly<z.ZodArray<z.ZodString, "many">>]>, z.ZodArray<z.ZodString, "many">]>>>>;
@@ -121296,6 +121334,7 @@ declare const subcircuitProps: z.ZodObject<{
121296
121334
  } | undefined;
121297
121335
  schRelative?: boolean | undefined;
121298
121336
  children?: any;
121337
+ schSheetName?: string | undefined;
121299
121338
  grid?: boolean | undefined;
121300
121339
  flex?: string | boolean | undefined;
121301
121340
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
@@ -121615,6 +121654,7 @@ declare const subcircuitProps: z.ZodObject<{
121615
121654
  } | undefined;
121616
121655
  schRelative?: boolean | undefined;
121617
121656
  children?: any;
121657
+ schSheetName?: string | undefined;
121618
121658
  grid?: boolean | undefined;
121619
121659
  flex?: string | boolean | undefined;
121620
121660
  layoutMode?: "none" | "relative" | "grid" | "flex" | "match-adapt" | undefined;
package/dist/index.js CHANGED
@@ -16338,6 +16338,7 @@ var baseGroupProps = commonLayoutProps.extend({
16338
16338
  name: z37.string().optional(),
16339
16339
  children: z37.any().optional(),
16340
16340
  schTitle: z37.string().optional(),
16341
+ schSheetName: z37.string().optional().describe('This group will be drawn as part of this sheet e.g. "Main"'),
16341
16342
  key: z37.any().optional(),
16342
16343
  showAsSchematicBox: z37.boolean().optional(),
16343
16344
  connections: z37.record(z37.string(), connectionTarget.optional()).optional(),