Skip to content

docs: add README visuals from the example app; fix its landscape grid - #31

Merged
mz-real merged 1 commit into
masterfrom
docs/example-visuals
Sep 25, 2026
Merged

mz-real merged 1 commit into
masterfrom
docs/example-visuals

Conversation

@mz-real

@mz-real mz-real commented Sep 25, 2026

Copy link
Copy Markdown
Owner

Summary

  • README visuals. A new "See it in action" section with:

    • a GIF of the example app widening from 1 to 2 to 3 columns (xs to lg to xxl), recorded from the web build
    • iPhone 16 (iOS 26.1 Simulator) screenshots in portrait (xs, one column) and landscape (lg, two columns)

    The images live in assets/readme/, which isn't in the npm package. The README uses absolute raw.githubusercontent.com URLs so they also render on npmjs.com.

  • Example app fix found in the iOS Simulator. In landscape only one card fit per row, because the card width was calculated from the full window and ignored the safe-area insets beside the Dynamic Island. Cards now use a percentage width with flexGrow, which fits the real available space. I checked it again in the Simulator: two columns in landscape, clear of the Dynamic Island.

  • Removes the em dash from the example's card text.

Test plan

  • Ran the example in Expo Go on the iPhone 16 Simulator in portrait and landscape, with no errors in Metro
  • Rebuilt the web export and captured the GIF (80 frames, 1.4 MB)
  • npm pack --dry-run doesn't include assets/
  • CI, including the example job

- README gains a 'See it in action' section: a GIF of the example app
  widening from one to three columns, and iPhone 16 Simulator
  screenshots in portrait and landscape. Images live in assets/readme/
  (not shipped in the npm package) and use absolute raw URLs so they
  render on npmjs.com too.
- Example app: running it in the iOS Simulator showed only one card per
  row in landscape, because the computed card width ignored the
  landscape safe-area insets. Cards now use a percentage width with
  flexGrow, so the column count fits the space actually available.
@mz-real
mz-real merged commit 33543d0 into master Sep 25, 2026
6 checks passed
@mz-real
mz-real deleted the docs/example-visuals branch September 25, 2026 22:20
@mz-real mz-real mentioned this pull request Sep 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant