mirror of
https://github.com/hanzoai/gui.git
synced 2026-10-25 02:31:41 +00:00
This repo could never sync. There was NO merge-base with tamagui — 372 commits
here against 15,791 there, unrelated histories — because it began as a
copy-paste rebrand with a flattened layout. Every "sync" since was a hand
re-application that drifted, which is why the tree sat on 7.3.1 while upstream
shipped fixes we then rediscovered by hand.
This commit's PARENT IS TAMAGUI. A future sync is `git merge tama/main` then
`node scripts/rebrand.mjs` — a real merge, because the history is now shared.
174 packages: 166 upstream, our 8 restored (chrome, shell, telemetry, recipes,
get, font-geist-{sans,mono}, @hanzo/booker), bento-get gained. 170/170 build.
Our patches to files UPSTREAM ALSO OWNS are carried, which the package-level
delta missed and which was where the value actually was:
- useMedia's server snapshot (`initState ?? getMedia()`). Upstream still
returns undefined there, so every Tamagui Dialog kills a prerender — the
exact crash hanzo.app spent a day on.
- data-slot on web host nodes, absent upstream entirely.
Both applied ONTO upstream's newer files (it rewrote useMedia +150/-63 and
createComponent +160/-55), marked `PATCH (ours, carried across the transplant)`.
Seven traps are encoded in scripts/rebrand.mjs, each found by a gate:
skip itself and lockfiles; special-case the double-branded names in BOTH scoped
and bare form; map path strings, not just paths; drop a level for the flattened
group; check disk rather than a stale index.
Rust build artifacts are NOT committed. An earlier draft of this commit swept
apps/desktop/src-tauri/target/debug in via `git add -A` — 3,859 files including
a 272MB .a, over GitHub's 100MB cap, so the push could never have landed. They
are gitignored now.
Co-Authored-By: Hanzo Dev <[email protected]>
100 lines
2.2 KiB
Plaintext
100 lines
2.2 KiB
Plaintext
---
|
|
title: Image
|
|
description: Web compatible and super light image component with Gui style props
|
|
name: hanzogui-image
|
|
component: Image
|
|
package: image
|
|
demoName: WebNativeImageDemo
|
|
---
|
|
|
|
<HeroContainer noPad>
|
|
<WebNativeImageDemo />
|
|
</HeroContainer>
|
|
|
|
```tsx hero template=WebNativeImage
|
|
|
|
```
|
|
|
|
<Highlights
|
|
features={[
|
|
'Web compatible.',
|
|
'Supports SSR.',
|
|
'Works on native and web.',
|
|
'No react-native-web dependency.',
|
|
'Super light.',
|
|
]}
|
|
/>
|
|
|
|
## Installation
|
|
|
|
Image is already installed in `hanzogui`, or you can install it independently:
|
|
|
|
```bash
|
|
npm install @hanzogui/image
|
|
```
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
export default () => <Image src="https://..." width={300} height={400} />
|
|
```
|
|
|
|
## API Reference
|
|
|
|
### Image
|
|
|
|
[Gui props](/docs/intro/props) +
|
|
[Web img props](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img) +
|
|
[React Native Image props](https://necolas.github.io/react-native-web/docs/image/).
|
|
|
|
<Notice>
|
|
All web [img](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img) props are
|
|
supported on web, and all native
|
|
[Image](https://necolas.github.io/react-native-web/docs/image/) props are supported on
|
|
native. On native we are still using web img APIs, but not all web img props are
|
|
supported, like `decoding`.
|
|
</Notice>
|
|
|
|
#### Some common props
|
|
|
|
<PropsTable
|
|
data={[
|
|
{
|
|
name: 'src',
|
|
required: true,
|
|
type: 'string',
|
|
description: `The image URL.`,
|
|
},
|
|
{
|
|
name: 'alt',
|
|
required: false,
|
|
type: 'string',
|
|
description: `Mandatory and incredibly useful for accessibility.`,
|
|
},
|
|
{
|
|
name: 'objectFit',
|
|
required: false,
|
|
type: 'CSS.ObjectFit',
|
|
description: `Sets how the content of the image is resized to fit its container. An alternative to the \`resizeMode\` prop.`,
|
|
},
|
|
{
|
|
name: 'unstyled',
|
|
required: false,
|
|
type: 'boolean',
|
|
description: `When true, removes all default styles.`,
|
|
},
|
|
{
|
|
name: 'onLoad',
|
|
required: false,
|
|
type: 'function',
|
|
description: `Callback when the image is loaded.`,
|
|
},
|
|
{
|
|
name: 'onError',
|
|
required: false,
|
|
type: 'function',
|
|
description: `Callback when the image fails to load.`,
|
|
},
|
|
]}
|
|
/>
|