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.

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

useShadowDom documentation updates #31

Open
mfulton26 opened this issue Feb 26, 2020 · 0 comments
Open

useShadowDom documentation updates #31

mfulton26 opened this issue Feb 26, 2020 · 0 comments

Comments

@mfulton26
Copy link

  1. the d.ts file uses optOutFromShadowRoot but the js code uses useShadowDom which means the type name is inverted

    export const create: (app: JSX.Element, tagName: string, optOutFromShadowRoot?: boolean) => void;

  2. the example in the readme is inverted (should be false but is true)

    ReactWebComponent.create(<App />, 'my-component', true);

  3. it might make more sense to pass in an options object to create instead of a single boolean flag so that it is clearer what true or false is doing at the callpoint

    e.g.

    ReactWebComponent.create(<App />, 'my-component', {useShadowDom: false});

    instead of

    ReactWebComponent.create(<App />, 'my-component', false);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant