9bc703a437
* mvp done * wip * fix ts errors and other code improvements * fix ts errors * ensure mobile layout support * Make skeleton responsive on screen resize * refactor * Add test for EmbedElement * make skeleton closer to pixel perfect * Address PR feedback * Remove PR_TODO --------- Co-authored-by: Benny Joo <sldisek783@gmail.com> Co-authored-by: amrit <iamamrit27@gmail.com>
40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
# Embeds
|
|
|
|
This folder contains all the various flavours of embeds.
|
|
|
|
`core` contains the core library written in vanilla JS that manages the embed.
|
|
`snippet` contains the Vanilla JS Code Snippet that can be installed on any website and would automatically fetch the `core` library.
|
|
|
|
Please see the respective folder READMEs for details on them.
|
|
|
|
## Publishing to NPM. It will soon be automated using changesets github action
|
|
|
|
To publish the packages. Following steps should be followed. All commands are to be run at the root.
|
|
|
|
1. `yarn changeset` -> Creates changelog files and adds summary to changelog. Select embed packages only here.
|
|
2. `yarn changeset version` -> Bumps the versions as required
|
|
3. Get the PR reviewed and merged
|
|
4. `yarn publish-embed` -> Releases all packages. We can't use `yarn changeset publish` because it doesn't support workspace: prefix removal yet. See https://github.com/changesets/changesets/issues/432#issuecomment-1016365428
|
|
|
|
## Skeleton Loader
|
|
|
|
Skeleton loader is shown for supported page types. For all other page types, default non-skeleton loader is shown.
|
|
Status:
|
|
- Layout
|
|
- [x] Responsive
|
|
- [x] Mobile Layout
|
|
- [x] month_view Layout
|
|
- [ ] week_view Layout
|
|
- [ ] column_view Layout
|
|
- Theming
|
|
- [x] Dark and Light theme
|
|
NOTE: _If user has preference for theme configured within app, that has to be communicated clearly in the embed too for skeleton to work_
|
|
- [x] Change in system theme should reflect without page refresh
|
|
- Page Types supported
|
|
- [x] user.event.booking.slots
|
|
- [x] team.event.booking.slots
|
|
- [x] [Partially supported] user.event.booking.form - Shows skeleton but of the slots page
|
|
- [x] [Partially supported] team.event.booking.form - Shows skeleton but of the slots page
|
|
- [ ] user.profile
|
|
- [ ] team.profile
|