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

Deprecate renderInstance #465

Closed
FlorianRappl opened this issue Jan 20, 2022 · 0 comments
Closed

Deprecate renderInstance #465

FlorianRappl opened this issue Jan 20, 2022 · 0 comments
Labels
documentation Concerns the available documentation. enhancement New feature or request framework Concerns the full piral library / framework.
Milestone

Comments

@FlorianRappl
Copy link
Contributor

New Feature Proposal

For more information, see the CONTRIBUTING guide.

Description

Right now piral-core uses the more explicit createInstance while piral introduces renderInstance. The latter should be deprecated and only one way should be used.

In 1.0 renderInstance would then be removed.

Background

Having "two ways" (or to be more precise: one convenience way on top of another way) is not good for documentation and transparency. With the more explicit createInstance the render call of react-dom would need to be called explicitly, which opens the door to more optimizations and customizations for the end-user.

Discussion

In general piral should only provide

  • resolution of peer dependencies (i.e., selection of dependency versions)
  • inclusion of some "standard" plugins via piral-ext

but nothing more. Consequently, the standard template(s) could be improved, too - if they work for piral-core they'd work for piral, too (only by exchanging the package name).

@FlorianRappl FlorianRappl added enhancement New feature or request documentation Concerns the available documentation. framework Concerns the full piral library / framework. labels Jan 20, 2022
@FlorianRappl FlorianRappl added this to the 0.15.0 milestone Jan 20, 2022
@FlorianRappl FlorianRappl added in-review The item is currently being reviewed. in-implementation The item is currently being implemented. and removed in-review The item is currently being reviewed. labels Jan 20, 2022
@FlorianRappl FlorianRappl removed the in-implementation The item is currently being implemented. label Feb 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Concerns the available documentation. enhancement New feature or request framework Concerns the full piral library / framework.
Projects
None yet
Development

No branches or pull requests

1 participant