mirror of
https://github.com/hanzoai/gui.git
synced 2026-10-25 02:31:41 +00:00
zeekayandHanzo Dev
751ef5c778
Both old names are owned by a different npm account (artemis-prime), so publishing them returns 403 — which is how this surfaced: the 8.0.0 run shipped @hanzogui/logo and @hanzogui/demos depending on [email protected], a version that cannot be published and therefore does not exist. Those two were uninstallable. @hanzo/gui and @hanzogui/* are ours, so the framework now carries the name it is imported by everywhere downstream, and the loader moves under the scope we control. The rewrite is limited to package references. `DEBUG?.startsWith('hanzogui')` is a log-namespace filter and join(dir, 'hanzogui') is a path — rewriting either would change behaviour, so both are untouched. Co-authored-by: Hanzo Dev <[email protected]>
76 lines
1.3 KiB
Plaintext
76 lines
1.3 KiB
Plaintext
---
|
|
title: Shapes
|
|
description: Easy to use Square and Circle.
|
|
name: shapes
|
|
component: Square
|
|
package: shapes
|
|
demoName: Shapes
|
|
---
|
|
|
|
<HeroContainer>
|
|
<ShapesDemo />
|
|
</HeroContainer>
|
|
|
|
```tsx hero template=Shapes
|
|
|
|
```
|
|
|
|
<Highlights
|
|
features={[
|
|
'Accepts size props as number or token value.',
|
|
'Sets min and max width and height.',
|
|
]}
|
|
/>
|
|
|
|
## Installation
|
|
|
|
Shapes is already installed in `hanzogui`, or you can install it independently:
|
|
|
|
```bash
|
|
npm install @hanzogui/shapes
|
|
```
|
|
|
|
## Usage
|
|
|
|
Gui supports sizing shapes using your `size` tokens, or plain numbers.
|
|
|
|
```tsx
|
|
import { Circle, Square } from '@hanzo/gui'
|
|
|
|
export default () => (
|
|
<>
|
|
<Square size="$4" />
|
|
<Square size={100} />
|
|
<Circle size="$4" />
|
|
<Circle size={100} />
|
|
</>
|
|
)
|
|
```
|
|
|
|
## API Reference
|
|
|
|
### Square
|
|
|
|
`Square` extends Stack views inheriting all the [Gui standard props](/docs/intro/props), plus:
|
|
|
|
<PropsTable
|
|
data={[
|
|
{
|
|
name: 'size',
|
|
required: false,
|
|
type: 'string | tokens.size',
|
|
description: `Set a size, number or one of the size token values.`,
|
|
},
|
|
{
|
|
name: 'circular',
|
|
required: false,
|
|
type: 'boolean',
|
|
description: `Rounds the border radius to be circular.`,
|
|
},
|
|
]}
|
|
/>
|
|
|
|
### Circle
|
|
|
|
`Circle` extends [Square](#square), setting `circular` to `true`.
|