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
219 changes: 203 additions & 16 deletions ThirdPartyNotices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,25 @@ This project incorporates components from the projects listed below.
12. @opentelemetry/resources version 1.30.1 (https://github.com/open-telemetry/opentelemetry-js)
13. @opentelemetry/sdk-trace-base version 1.30.1 (https://github.com/open-telemetry/opentelemetry-js)
14. @opentelemetry/semantic-conventions version 1.30.0 (https://github.com/open-telemetry/opentelemetry-js)
15. @shoelace-style/shoelace version 2.20.0 (https://github.com/shoelace-style/shoelace)
16. @vscode/codicons version 0.0.36 (https://github.com/microsoft/vscode-codicons)
17. billboard.js version 3.14.3 (https://github.com/naver/billboard.js)
18. https-proxy-agent version 5.0.1 (https://github.com/TooTallNate/node-https-proxy-agent)
19. iconv-lite version 0.6.3 (https://github.com/ashtuchkin/iconv-lite)
20. lit version 3.2.1 (https://github.com/lit/lit)
21. marked version 15.0.7 (https://github.com/markedjs/marked)
22. microsoft/vscode (https://github.com/microsoft/vscode)
23. node-fetch version 2.7.0 (https://github.com/bitinn/node-fetch)
24. os-browserify version 0.3.0 (https://github.com/CoderPuppy/os-browserify)
25. path-browserify version 1.0.1 (https://github.com/browserify/path-browserify)
26. react-dom version 16.8.4 (https://github.com/facebook/react)
27. react version 16.8.4 (https://github.com/facebook/react)
28. signal-utils version 0.21.1 (https://github.com/proposal-signals/signal-utils)
29. slug version 10.0.0 (https://github.com/Trott/slug)
30. sortablejs version 1.15.0 (https://github.com/SortableJS/Sortable)
15. @r2wc/react-to-web-component version 2.0.4 (https://github.com/bitovi/react-to-web-component)
16. @shoelace-style/shoelace version 2.20.0 (https://github.com/shoelace-style/shoelace)
17. @vscode/codicons version 0.0.36 (https://github.com/microsoft/vscode-codicons)
18. billboard.js version 3.14.3 (https://github.com/naver/billboard.js)
19. https-proxy-agent version 5.0.1 (https://github.com/TooTallNate/node-https-proxy-agent)
20. iconv-lite version 0.6.3 (https://github.com/ashtuchkin/iconv-lite)
21. lit version 3.2.1 (https://github.com/lit/lit)
22. marked version 15.0.7 (https://github.com/markedjs/marked)
23. microsoft/vscode (https://github.com/microsoft/vscode)
24. node-fetch version 2.7.0 (https://github.com/bitinn/node-fetch)
25. os-browserify version 0.3.0 (https://github.com/CoderPuppy/os-browserify)
26. path-browserify version 1.0.1 (https://github.com/browserify/path-browserify)
27. react-dom version 16.14.0 (https://github.com/facebook/react)
28. react-dom version 19.0.0 (https://github.com/facebook/react)
29. react version 16.14.0 (https://github.com/facebook/react)
30. react version 19.0.0 (https://github.com/facebook/react)
31. signal-utils version 0.21.1 (https://github.com/proposal-signals/signal-utils)
32. slug version 10.0.0 (https://github.com/Trott/slug)
33. sortablejs version 1.15.0 (https://github.com/SortableJS/Sortable)

%% @gk-nzaytsev/fast-string-truncated-width NOTICES AND INFORMATION BEGIN HERE
=========================================
Expand Down Expand Up @@ -1324,6 +1327,136 @@ END OF @opentelemetry/sdk-trace-base NOTICES AND INFORMATION
=========================================
END OF @opentelemetry/semantic-conventions NOTICES AND INFORMATION

%% @r2wc/react-to-web-component NOTICES AND INFORMATION BEGIN HERE
=========================================
# React to Web Component

`@r2wc/react-to-web-component` converts [React](https://reactjs.org/) components to [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements)! It lets you share React components as native elements that **don't** require being mounted through React. The custom element acts as a wrapper for the underlying React component. Use these custom elements with any project that uses HTML even in any framework (vue, svelte, angular, ember, canjs) the same way you would use standard HTML elements.

> Note: The latest version of this package only works with the React 18. If you are using React 16 or 17, please use version 1.

`@r2wc/react-to-web-component`:

- Works in all modern browsers. (Edge needs a [customElements polyfill](https://github.com/webcomponents/polyfills/tree/master/packages/custom-elements)).
- Is `1.26KB` minified and gzipped.

## Setup

To install from npm:

```
npm install @r2wc/react-to-web-component
```

## Need help or have questions?

This project is supported by [Bitovi, a React consultancy](https://www.bitovi.com/frontend-javascript-consulting/react-consulting). You can get help or ask questions on our:

- [Discord Community](https://discord.gg/J7ejFsZnJ4)
- [Twitter](https://twitter.com/bitovi)

Or, you can hire us for training, consulting, or development. [Set up a free consultation.](https://www.bitovi.com/frontend-javascript-consulting/react-consulting)

## Basic Use

For basic usage, we will use this simple React component:

```js
const Greeting = () => {
return <h1>Hello, World!</h1>
}
```

With our React component complete, all we have to do is call `r2wc` and [customElements.define](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry/define) to create and define our custom element:

```js
import r2wc from "@r2wc/react-to-web-component"

const WebGreeting = r2wc(Greeting)

customElements.define("web-greeting", WebGreeting)
```

Now we can use `<web-greeting>` like any other HTML element!

```html
<body>
<h1>Greeting Demo</h1>

<web-greeting></web-greeting>
</body>
```

In the above case, the web-greeting custom element is not making use of the `name` property from our `Greeting` component.

## Working with Attributes

By default, custom elements created by `r2wc` only pass properties to the underlying React component. To make attributes work, you must specify your component's props.

```js
const Greeting = ({ name }) => {
return <h1>Hello, {name}!</h1>
}

const WebGreeting = r2wc(Greeting, {
props: {
name: "string",
},
})
```

Now `r2wc` will know to look for `name` attributes
as follows:

```html
<body>
<h1>Greeting Demo</h1>

<web-greeting name="Justin"></web-greeting>
</body>
```

For projects needing more advanced usage of the web components, see our [programatic usage and declarative demos](docs/programatic-usage.md).

We also have a [complete example using a third party library](docs/complete-example.md).

## Examples

- [Hello World](https://codesandbox.io/s/hello-world-md5oih) - The quintessential software demo!
- [All the Props](https://codesandbox.io/s/all-the-props-n8z5hv) - A demo of all the prop transform types that R2WC supports.
- [Header Example](https://codesandbox.io/s/example-header-blog-7k313l) - An example reusable Header component.
- [MUI Button](https://codesandbox.io/s/example-mui-button-qwidh9) - An example application using an MUI button with theme customization.
- [Checklist Demo](https://codesandbox.io/s/example-checklist-blog-y3nqwx) - An example Checklist application.

## Blog Posts

R2WC with Vite [View Post](https://www.bitovi.com/blog/react-everywhere-with-vite-and-react-to-webcomponent)

R2WC with Create React App (CRA) [View Post](https://www.bitovi.com/blog/how-to-create-a-web-component-with-create-react-app)

## How it works

Check out our [full API documentation](https://github.com/bitovi/react-to-web-component/blob/main/docs/api.md).

Under the hood, `r2wc` creates a `CustomElementConstructor` with custom getters/setters and life cycle methods that keep track of the props that you have defined. When a property is set, its custom setter:

- re-renders the React component inside the custom element.
- creates an enumerable getter / setter on the instance to save the set value and avoid hitting the proxy in the future.

Also:

- Enumerable properties and values on the custom element are used as the `props` passed to the React component.
- The React component is not rendered until the custom element is inserted into the page.

# We want to hear from you.

Come chat with us about open source in our Bitovi community [Discord](https://discord.gg/J7ejFsZnJ4).

See what we're up to by following us on [Twitter](https://twitter.com/bitovi).

=========================================
END OF @r2wc/react-to-web-component NOTICES AND INFORMATION

%% @shoelace-style/shoelace NOTICES AND INFORMATION BEGIN HERE
=========================================
Copyright (c) 2020 A Beautiful Site, LLC
Expand Down Expand Up @@ -2152,6 +2285,33 @@ SOFTWARE.
=========================================
END OF react-dom NOTICES AND INFORMATION

%% react-dom NOTICES AND INFORMATION BEGIN HERE
=========================================
MIT License

Copyright (c) Meta Platforms, Inc. and affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

=========================================
END OF react-dom NOTICES AND INFORMATION

%% react NOTICES AND INFORMATION BEGIN HERE
=========================================
MIT License
Expand Down Expand Up @@ -2179,6 +2339,33 @@ SOFTWARE.
=========================================
END OF react NOTICES AND INFORMATION

%% react NOTICES AND INFORMATION BEGIN HERE
=========================================
MIT License

Copyright (c) Meta Platforms, Inc. and affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

=========================================
END OF react NOTICES AND INFORMATION

%% signal-utils NOTICES AND INFORMATION BEGIN HERE
=========================================
MIT License
Expand Down
1 change: 1 addition & 0 deletions docs/telemetry-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -919,6 +919,7 @@ or
'context.config.dateStyle': 'absolute' | 'relative',
'context.config.defaultItemLimit': number,
'context.config.dimMergeCommits': boolean,
'context.config.experimental.renderer.enabled': boolean,
'context.config.highlightRowsOnRefHover': boolean,
'context.config.issues.enabled': boolean,
'context.config.layout': 'editor' | 'panel',
Expand Down
24 changes: 20 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -1057,6 +1057,16 @@
"scope": "window",
"order": 300
},
"gitlens.graph.experimental.renderer.enabled": {
"type": "boolean",
"default": false,
"markdownDescription": "(Experimental) Specifies whether to use the new renderer for the _Commit Graph_. Requires a restart",
"scope": "window",
"order": 301,
"tags": [
"experimental"
]
},
"gitlens.graph.branchesVisibility": {
"type": "string",
"enum": [
Expand Down Expand Up @@ -21402,13 +21412,13 @@
"analyze:bundle": "webpack --mode production --env analyzeBundle",
"analyze:bundle:extension": "webpack --mode production --config-name extension:node --env analyzeBundle",
"analyze:bundle:extension:browser": "webpack --mode production --config-name extension:webworker --env analyzeBundle",
"analyze:bundle:webviews": "webpack --mode production --config-name webviews --env analyzeBundle",
"analyze:bundle:webviews": "webpack --mode production --config-name webviews:common --config-name webviews --config-name webviews:graph-next --env analyzeBundle",
"analyze:deps": "webpack --env analyzeDeps",
"build": "webpack --mode development",
"build:quick": "webpack --mode development --env skipLint",
"build:extension": "webpack --mode development --config-name extension:node",
"build:extension:browser": "webpack --mode development --config-name extension:webworker",
"build:webviews": "webpack --mode development --config-name webviews",
"build:webviews": "webpack --mode development --config-name webviews:common --config-name webviews --config-name webviews:graph-next",
"build:icons": "pnpm run icons:svgo && pnpm fantasticon && pnpm run icons:apply && pnpm run icons:export",
"build:tests": "node ./scripts/esbuild.tests.mjs",
"// Extracts the contributions from package.json into contributions.json": "//",
Expand Down Expand Up @@ -21465,6 +21475,7 @@
},
"dependencies": {
"@gitkraken/gitkraken-components": "10.7.0",
"@gitkraken/gitkraken-components-next": "npm:@gitkraken/[email protected]",
"@gitkraken/provider-apis": "0.26.2",
"@gitkraken/shared-web-components": "0.1.1-rc.15",
"@gk-nzaytsev/fast-string-truncated-width": "1.1.0",
Expand All @@ -21481,6 +21492,7 @@
"@opentelemetry/resources": "1.30.1",
"@opentelemetry/sdk-trace-base": "1.30.1",
"@opentelemetry/semantic-conventions": "1.30.0",
"@r2wc/react-to-web-component": "^2.0.4",
"@shoelace-style/shoelace": "2.20.0",
"@vscode/codicons": "0.0.36",
"billboard.js": "3.14.3",
Expand All @@ -21491,8 +21503,10 @@
"node-fetch": "2.7.0",
"os-browserify": "0.3.0",
"path-browserify": "1.0.1",
"react": "16.8.4",
"react-dom": "16.8.4",
"react": "16.14.0",
"react-dom": "16.14.0",
"react-next": "npm:[email protected]",
"react-dom-next": "npm:[email protected]",
"signal-utils": "0.21.1",
"slug": "10.0.0",
"sortablejs": "1.15.0"
Expand All @@ -21506,7 +21520,9 @@
"@types/mocha": "10.0.10",
"@types/node": "20.14.15",
"@types/react": "17.0.83",
"@types/react-next": "npm:@types/[email protected]",
"@types/react-dom": "17.0.25",
"@types/react-dom-next": "npm:@types/[email protected]",
"@types/sinon": "17.0.4",
"@types/slug": "5.0.9",
"@types/sortablejs": "1.15.8",
Expand Down
Loading