Reexport preact && bundle library #124
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
barmac
added a commit
to bpmn-io/bpmn-js-properties-panel
that referenced
this pull request
Dec 10, 2021
This adjusts the imports according to the new structure implemented via bpmn-io/properties-panel#124
barmac
added a commit
to bpmn-io/bpmn-js-properties-panel
that referenced
this pull request
Dec 10, 2021
This adjusts the imports according to the new structure implemented via bpmn-io/properties-panel#124
barmac
force-pushed
the
reexport-preact
branch
from
4585966
to
ebbaa1d
Compare
This allows to make sure any packages depending on the project
as well as user's extension use the same instance of the preact
package, thus making hooks and other features work smoothly.
Instead of installing and import preact in your project, import
the library from the properties panel package, e.g.
```javascript
import { h } from '@bpmn-io/properties-panel/preact';
function CustomComponent(props) {
return h('div', 'hello world!');
}
```
If you transpile from JSX, the babel `importSource` should be set
accordingly:
```json
{
"plugins": [
[ "@babel/plugin-transform-react-jsx", {
"importSource": "@bpmn-io/properties-panel/preact",
"runtime": "automatic"
} ]
```
barmac
force-pushed
the
reexport-preact
branch
from
ebbaa1d
to
26e11c4
Compare
bpmn-io-tasks
bot
added
needs review
barmac
commented
Dec 14, 2021
| @@ -0,0 +1,15 @@ | |||
| { | |||
There was a problem hiding this comment.
Renamed so that it can be automatically parsed via require in the karma config.
barmac
commented
Dec 14, 2021
.eslintignore
Outdated
| /node_modules | ||
| /lib |
There was a problem hiding this comment.
Prepending slash means that the ignore will be applied only to the root of the repo.
The library no longer exposes its internal structure in `lib`.
Instead, exports can be accessed from the root.
```javascript
import { Group, TextFieldEntry } from @bpmn-io/properties-panel;
const myGroup = {
id: myGroup,
component: Group,
entries: [
{ id: customEntry, component: <TextFieldEntry /* ... */ /> }
]
};
```
BREAKING CHANGES:
* Internal structure of the library is no longer exposed.
Use root exports instead.
barmac
force-pushed
the
reexport-preact
branch
from
79c2483
to
4d6eeb0
Compare
barmac
added a commit
to bpmn-io/bpmn-js-properties-panel
that referenced
this pull request
Dec 14, 2021
This adjusts the imports according to the new structure implemented via bpmn-io/properties-panel#124
barmac
added a commit
to bpmn-io/bpmn-js-properties-panel
that referenced
this pull request
Dec 15, 2021
This adjusts the imports according to the new structure implemented via bpmn-io/properties-panel#124
barmac
added a commit
to bpmn-io/bpmn-js-properties-panel
that referenced
this pull request
Dec 15, 2021
This adjusts the imports according to the new structure implemented via bpmn-io/properties-panel#124
barmac
added a commit
to bpmn-io/bpmn-js-properties-panel
that referenced
this pull request
Dec 15, 2021
This adjusts the imports according to the new structure implemented via bpmn-io/properties-panel#124
marstamm
pushed a commit
to bpmn-io/bpmn-js-element-templates
that referenced
this pull request
Jun 8, 2023
This adjusts the imports according to the new structure implemented via bpmn-io/properties-panel#124
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces bundling to the library so that it's easier to re-export
its contents in the context of a pluggable application (Camunda Modeler).
We re-export
preactpackage together with subpackages to make sureplugin creators can depend on the same instance which is essential
for the hooks to work correctly.
Some examples of the new way (copied from the commit messages):
For
preactIf you transpile from JSX, the babel
importSourceshould be setaccordingly:
{ "plugins": [ [ "@babel/plugin-transform-react-jsx", { "importSource": "@bpmn-io/properties-panel/preact", "runtime": "automatic" } ]BREAKING CHANGES:
Use root exports instead.