Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ecosystem-html-web-components.md #126

Merged
merged 1 commit into from
Dec 3, 2019
Merged

Update ecosystem-html-web-components.md #126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 docs/ecosystem-html-web-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ Example usage when installed via CDN:

```js
const webComponentApp = window.singleSpaHtml.default({
template: '<x-my-web-component></x-my-web-component>',
template: props => `<x-my-web-component attr="${props.attr}"></x-my-web-component>`,
})

singleSpa.registerApplication('name', webComponentApp, () => true)
```

## API / Options
single-spa-html is called with an object that has the following properties:
- `template` (required): An HTML string that will be injected into the DOM during the single-spa mount lifecycle.
- `template` (required): An HTML string or a function that returns a string. The function will be called with the single-spa custom props. The returned string is injected into the DOM during the single-spa mount lifecycle.
- `domElementGetter` (optional): A function that returns the dom element container into which the HTML will be injected. If omitted,
a default implementation is provided that wraps the template in a `<div>` that is appended to `document.body`.
a default implementation is provided that wraps the template in a `<div>` that is appended to `document.body`.