Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This is what's different:

## How To Use

When doing *CollageJS* piece (micro-frontend) projects, we don't have to do much. We simply tell the `@collagejs/vite-im` Vite plug-in to add it. The plug-in will inject the map-overriding script and the user interface module (which itself is a *CollageJS* piece). See that plug-in's documentation for more information.
When doing *CollageJS* piece (micro-frontend) projects, we don't have to do much. We simply tell the `@collagejs/vite-im` Vite plug-in to add it (and by default, it has been told). The plug-in will inject the map-overriding script and the user interface module (which itself is a *CollageJS* piece). See that plug-in's documentation for more information.

### Using On Its Own

Expand Down Expand Up @@ -57,7 +57,7 @@ In your HTML page, after all overridable import maps, inject the script with a `
<script type="application/javascript" src="https://cdn.jsdelivr.net/npm/@collagejs/imo@latest/dist/imo.min.js"></script>
<script type="application/json" id="collagejs-imo-ui-options">
{
"base": "https://cdn.jsdelivr.net/npm/@collagejs/imo@latest"
"base": "https://cdn.jsdelivr.net/npm/@collagejs/imo@latest/dist/"
}
</script>
</head>
Expand Down Expand Up @@ -190,7 +190,7 @@ type ImoUiFactoryOptions = {
#### Options

- `base`: Base path used to locate the user interface's CSS.
- `shadowDom`: Set to `true` to have the piece mount in Shadow DOM.
- `shadow`: Set to `true` to have the piece mount in Shadow DOM.
- `ui.position`: The position of the dev-mode user interface being mounted.
- `ui.language`: The language used in the user interface.
- `ui.theme`: The user interface theme.
Expand Down
Loading
Loading