https://github.com/vtex/admin-iframe-container

Iframe interface for VTEX admin apps
https://github.com/vtex/admin-iframe-container

srv-admin xp-developer

Last synced: about 1 month ago
JSON representation

Iframe interface for VTEX admin apps

• Host: GitHub
• URL: https://github.com/vtex/admin-iframe-container
• Owner: vtex
• Created: 2019-07-10T14:51:22.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T01:07:29.000Z (over 1 year ago)
• Last Synced: 2024-04-14T22:51:51.495Z (9 months ago)
• Topics: srv-admin, xp-developer
• Language: TypeScript
• Size: 615 KB
• Stars: 1
• Watchers: 130
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Admin Iframe Container 2.x

Iframe that loads every VTEX admin application.

## 📦 Instaling

This a VTEX IO app you just have to install it with:

```sh

vtex install [email protected]

```

## 👨🏾‍💻 Development

You just need to to make the changes and link the app with `vtex link`.

### 🌎 Important peer apps

While developing, you should be aware of important apps:

- [admin](https://github.com/vtex/admin) - Application that uses this app. It will pass all props to `IframeContainer`.

- [admin-proxy](https://github.com/vtex/admin-proxy) - Rewrite requests from vtexcommerce urls to myvtex, so that the iframe can be displayed on modern browsers.

- [admin-iframe-compatibility](https://github.com/vtex/admin-iframe-compatibility) - Static jquery code that runs on legacy apps.

### 🏗 File structure

About this app files

```

/react - main source

../components - compose vtex io with core components

../..Iframe.ts - loads admin v2 & v3 apps

../..IframeContainer.ts - selects the correct iframe to load

../..IframeLegacy.ts - loads admin v1 apps

../..LegacyHeader.ts - header of admin v1 apps

../core - components that use admin-ui library

../../Navbar - renders the app title & back link of legacy apps

../../PageHeader - renders Navbar + Tabs

../../Tabs - renders Tabs of legacy apps

../hooks

../..useLoading.ts - triggers frame loading bar

../..useForceUpdate.ts - force updates a component

../util - common utilities

.Iframe.ts - exports components/IframeContainer

```