From 1c6f237b1d457d68d194cc3fd4fae4193c1674c9 Mon Sep 17 00:00:00 2001 From: techmannih Date: Sat, 18 Jan 2025 01:25:51 +0530 Subject: [PATCH 1/2] add all core component --- api-reference/components/Battery.mdx | 14 ++++++++ api-reference/components/Board.mdx | 41 ++++++++++++++++++++++ api-reference/components/Chip.mdx | 22 ++++++++++++ api-reference/components/Crystal.mdx | 18 ++++++++++ api-reference/components/Jumper.mdx | 22 ++++++++++++ api-reference/components/Mosfet.mdx | 21 +++++++++++ api-reference/components/PinHeader.mdx | 21 +++++++++++ api-reference/components/Potentiometer.mdx | 21 +++++++++++ api-reference/components/PushButton.mdx | 16 +++++++++ api-reference/components/Resonator.mdx | 20 +++++++++++ 10 files changed, 216 insertions(+) create mode 100644 api-reference/components/Battery.mdx create mode 100644 api-reference/components/Board.mdx create mode 100644 api-reference/components/Chip.mdx create mode 100644 api-reference/components/Crystal.mdx create mode 100644 api-reference/components/Jumper.mdx create mode 100644 api-reference/components/Mosfet.mdx create mode 100644 api-reference/components/PinHeader.mdx create mode 100644 api-reference/components/Potentiometer.mdx create mode 100644 api-reference/components/PushButton.mdx create mode 100644 api-reference/components/Resonator.mdx diff --git a/api-reference/components/Battery.mdx b/api-reference/components/Battery.mdx new file mode 100644 index 0000000..52cf900 --- /dev/null +++ b/api-reference/components/Battery.mdx @@ -0,0 +1,14 @@ +--- +title: 'Battery' +--- + +A Battery component to define battery parameters and customize layout. + +## Example Usage + +```tsx +export const ExampleBatteryUsage = () => ( + + +) +``` diff --git a/api-reference/components/Board.mdx b/api-reference/components/Board.mdx new file mode 100644 index 0000000..9991a8a --- /dev/null +++ b/api-reference/components/Board.mdx @@ -0,0 +1,41 @@ + +```mdx +--- +title: 'Board' +--- + +A Board component to define a circuit board layout and customize pin configurations. + +## Example Usage + +```tsx +export const ExampleBoardUsage = () => ( + + + + +) +``` \ No newline at end of file diff --git a/api-reference/components/Chip.mdx b/api-reference/components/Chip.mdx new file mode 100644 index 0000000..6804f9f --- /dev/null +++ b/api-reference/components/Chip.mdx @@ -0,0 +1,22 @@ + +```mdx +--- +title: 'Chip' +--- + +A Chip component to define a semiconductor chip with configuration options. + +## Example Usage + +```tsx +export const ExampleChipUsage = () => ( + +) +``` diff --git a/api-reference/components/Crystal.mdx b/api-reference/components/Crystal.mdx new file mode 100644 index 0000000..906c807 --- /dev/null +++ b/api-reference/components/Crystal.mdx @@ -0,0 +1,18 @@ + +```mdx +--- +title: 'Crystal' +--- + +A Crystal component to define frequency and package type. + +## Example Usage + +```tsx +export const ExampleCrystalUsage = () => ( + +) +``` diff --git a/api-reference/components/Jumper.mdx b/api-reference/components/Jumper.mdx new file mode 100644 index 0000000..5e5627d --- /dev/null +++ b/api-reference/components/Jumper.mdx @@ -0,0 +1,22 @@ + +```mdx +--- +title: 'Jumper' +--- + +A Jumper component to define jumper specifications. + +## Example Usage + +```tsx +export const ExampleJumperUsage = () => ( + +) +``` diff --git a/api-reference/components/Mosfet.mdx b/api-reference/components/Mosfet.mdx new file mode 100644 index 0000000..f2e9e97 --- /dev/null +++ b/api-reference/components/Mosfet.mdx @@ -0,0 +1,21 @@ + +### 10. `Mosfet.ts.mdx` +```mdx +--- +title: 'MOSFET' +--- + +A MOSFET component to define voltage, current, and switching characteristics. + +## Example Usage + +```tsx +export const ExampleMosfetUsage = () => ( + +) +``` diff --git a/api-reference/components/PinHeader.mdx b/api-reference/components/PinHeader.mdx new file mode 100644 index 0000000..bd7aab5 --- /dev/null +++ b/api-reference/components/PinHeader.mdx @@ -0,0 +1,21 @@ + +```mdx +--- +title: 'PinHeader' +--- + +A PinHeader component to define pin count and spacing for headers. + +## Example Usage + +```tsx +export const ExamplePinHeaderUsage = () => ( + +) +``` diff --git a/api-reference/components/Potentiometer.mdx b/api-reference/components/Potentiometer.mdx new file mode 100644 index 0000000..c66aff6 --- /dev/null +++ b/api-reference/components/Potentiometer.mdx @@ -0,0 +1,21 @@ + +```mdx +--- +title: 'Potentiometer' +--- + +A Potentiometer component to define resistance and package type. + +## Example Usage + +```tsx +export const ExamplePotentiometerUsage = () => ( + +) +``` diff --git a/api-reference/components/PushButton.mdx b/api-reference/components/PushButton.mdx new file mode 100644 index 0000000..b06918b --- /dev/null +++ b/api-reference/components/PushButton.mdx @@ -0,0 +1,16 @@ + +```mdx +--- +title: 'PushButton' +--- + +A PushButton component to define button specifications like type and action. + +## Example Usage + +```tsx +export const ExamplePushButtonUsage = () => ( + + +) +``` diff --git a/api-reference/components/Resonator.mdx b/api-reference/components/Resonator.mdx new file mode 100644 index 0000000..85f11d0 --- /dev/null +++ b/api-reference/components/Resonator.mdx @@ -0,0 +1,20 @@ + +```mdx +--- +title: 'Resonator' +--- + +A Resonator component to define frequency and package style. + +## Example Usage + +```tsx +export const ExampleResonatorUsage = () => ( + +) +``` From 95493350f4e3967d20b1ef07ee21fd3d7f4f2cdb Mon Sep 17 00:00:00 2001 From: techmannih Date: Sat, 18 Jan 2025 10:15:08 +0530 Subject: [PATCH 2/2] add components --- api-reference/components/Battery.mdx | 2 +- api-reference/components/Board.mdx | 4 +-- api-reference/components/Chip.mdx | 4 +-- api-reference/components/Crystal.mdx | 4 +-- api-reference/components/Jumper.mdx | 4 +-- api-reference/components/Mosfet.mdx | 5 +--- api-reference/components/PinHeader.mdx | 4 +-- api-reference/components/Potentiometer.mdx | 4 +-- api-reference/components/PushButton.mdx | 4 +-- api-reference/components/Resonator.mdx | 4 +-- mint.json | 31 ++++++++++++++++------ 11 files changed, 33 insertions(+), 37 deletions(-) diff --git a/api-reference/components/Battery.mdx b/api-reference/components/Battery.mdx index 52cf900..e7954f0 100644 --- a/api-reference/components/Battery.mdx +++ b/api-reference/components/Battery.mdx @@ -1,5 +1,5 @@ --- -title: 'Battery' +title: '' --- A Battery component to define battery parameters and customize layout. diff --git a/api-reference/components/Board.mdx b/api-reference/components/Board.mdx index 9991a8a..ed5b817 100644 --- a/api-reference/components/Board.mdx +++ b/api-reference/components/Board.mdx @@ -1,7 +1,5 @@ - -```mdx --- -title: 'Board' +title: '' --- A Board component to define a circuit board layout and customize pin configurations. diff --git a/api-reference/components/Chip.mdx b/api-reference/components/Chip.mdx index 6804f9f..19bfabc 100644 --- a/api-reference/components/Chip.mdx +++ b/api-reference/components/Chip.mdx @@ -1,7 +1,5 @@ - -```mdx --- -title: 'Chip' +title: '' --- A Chip component to define a semiconductor chip with configuration options. diff --git a/api-reference/components/Crystal.mdx b/api-reference/components/Crystal.mdx index 906c807..c54d2c3 100644 --- a/api-reference/components/Crystal.mdx +++ b/api-reference/components/Crystal.mdx @@ -1,7 +1,5 @@ - -```mdx --- -title: 'Crystal' +title: '' --- A Crystal component to define frequency and package type. diff --git a/api-reference/components/Jumper.mdx b/api-reference/components/Jumper.mdx index 5e5627d..51dd903 100644 --- a/api-reference/components/Jumper.mdx +++ b/api-reference/components/Jumper.mdx @@ -1,7 +1,5 @@ - -```mdx --- -title: 'Jumper' +title: '' --- A Jumper component to define jumper specifications. diff --git a/api-reference/components/Mosfet.mdx b/api-reference/components/Mosfet.mdx index f2e9e97..86fa0d4 100644 --- a/api-reference/components/Mosfet.mdx +++ b/api-reference/components/Mosfet.mdx @@ -1,8 +1,5 @@ - -### 10. `Mosfet.ts.mdx` -```mdx --- -title: 'MOSFET' +title: '' --- A MOSFET component to define voltage, current, and switching characteristics. diff --git a/api-reference/components/PinHeader.mdx b/api-reference/components/PinHeader.mdx index bd7aab5..ee5162b 100644 --- a/api-reference/components/PinHeader.mdx +++ b/api-reference/components/PinHeader.mdx @@ -1,7 +1,5 @@ - -```mdx --- -title: 'PinHeader' +title: '' --- A PinHeader component to define pin count and spacing for headers. diff --git a/api-reference/components/Potentiometer.mdx b/api-reference/components/Potentiometer.mdx index c66aff6..d8d7189 100644 --- a/api-reference/components/Potentiometer.mdx +++ b/api-reference/components/Potentiometer.mdx @@ -1,7 +1,5 @@ - -```mdx --- -title: 'Potentiometer' +title: '' --- A Potentiometer component to define resistance and package type. diff --git a/api-reference/components/PushButton.mdx b/api-reference/components/PushButton.mdx index b06918b..631899a 100644 --- a/api-reference/components/PushButton.mdx +++ b/api-reference/components/PushButton.mdx @@ -1,7 +1,5 @@ - -```mdx --- -title: 'PushButton' +title: '' --- A PushButton component to define button specifications like type and action. diff --git a/api-reference/components/Resonator.mdx b/api-reference/components/Resonator.mdx index 85f11d0..ed00802 100644 --- a/api-reference/components/Resonator.mdx +++ b/api-reference/components/Resonator.mdx @@ -1,7 +1,5 @@ - -```mdx --- -title: 'Resonator' +title: '' --- A Resonator component to define frequency and package style. diff --git a/mint.json b/mint.json index e1acecf..15581d6 100644 --- a/mint.json +++ b/mint.json @@ -51,7 +51,10 @@ "navigation": [ { "group": "Get Started", - "pages": ["quickstart", "registry"] + "pages": [ + "quickstart", + "registry" + ] }, { "group": "Tutorials", @@ -69,18 +72,28 @@ { "group": "Core Components", "pages": [ + "api-reference/components/battery", + "api-reference/components/board", "api-reference/components/bug", - "api-reference/components/resistor", "api-reference/components/capacitor", - "api-reference/components/inductor", - "api-reference/components/transistor", - "api-reference/components/trace", + "api-reference/components/chip", "api-reference/components/component", + "api-reference/components/crystal", "api-reference/components/diode", + "api-reference/components/group", + "api-reference/components/inductor", + "api-reference/components/jumper", "api-reference/components/led", + "api-reference/components/mosfet", "api-reference/components/netalias", + "api-reference/components/pinheader", + "api-reference/components/potentiometer", "api-reference/components/powersource", - "api-reference/components/group" + "api-reference/components/pushbutton", + "api-reference/components/resistor", + "api-reference/components/resonator", + "api-reference/components/trace", + "api-reference/components/transistor" ] }, { @@ -108,7 +121,9 @@ }, { "group": "Advanced", - "pages": ["api-reference/advanced/soup"] + "pages": [ + "api-reference/advanced/soup" + ] } ], "footerSocials": { @@ -116,4 +131,4 @@ "github": "https://github.com/tscircuit/tscircuit", "linkedin": "https://www.linkedin.com/company/tscircuit" } -} +} \ No newline at end of file