https://github.com/teambit/custom-preview-example

a workspace showcasing a custom preview aspect
https://github.com/teambit/custom-preview-example

Last synced: 3 months ago
JSON representation

a workspace showcasing a custom preview aspect

• Host: GitHub
• URL: https://github.com/teambit/custom-preview-example
• Owner: teambit
• License: other
• Created: 2021-07-21T13:13:35.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-10-30T14:14:01.000Z (over 1 year ago)
• Last Synced: 2025-01-14T09:38:00.354Z (5 months ago)
• Language: TypeScript
• Size: 908 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Images preview

This project showcases an `aspect` (bit extension) that presents all the images in a component.

![screenshot](./docs/screenshot.png)

# What's included

It does 3 things:

1. Add a tab in the component page with an iframe to the preview. (`component-images.ui.runtime.tsx`)

1. Render the _images preview_ inside the iframe (`component-images.preview.runtime.ts`)

1. Bundles the images as their own _preview target_. (`component-images.main.runtime.ts`).

   this also bundles the preview template (`component-images-app.tsx`)

# setup

- `bit install`

- `bit compile`

- make sure there are no errors using `bit status`

- `bit start` (add `--dev` when editing the custom extension)