Skip to content

Commit a494154

Browse files
committed
finalized migration guide and Changelog
1 parent 0e9088d commit a494154

File tree

3 files changed

+197
-75
lines changed

3 files changed

+197
-75
lines changed

CHANGELOG.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,8 @@
11
# Changelog
22

3-
## v2.0.0 Release (in progress, not released)
3+
## v2.0.0 Release - 2021-04-12
44

5-
TODO: Provide proper migration guide
6-
7-
* removed internal dependencies from cells, haml and trailblazer-cells
8-
9-
* passing text with option :text is deprecated, please pass text as first argument
10-
11-
* changes for components
12-
* `area` coords will no longer be automatically joined -> html option does exactly what is expected, no magic
13-
* content blocks take precedence over text or :text option
14-
* `heading` component does not exist anymore. use `h1`,`h2`,`h3`...instead
15-
* `italic` and `icon` are now called with the corresponding html tag `i`
16-
* `link`has no more option :path which can take a symbol and renders it with rails url helper. Use :href with or without rails url helper instead
17-
* `unescaped` renamed to `unescape` as it fits the naming conventions more. For example rails html_escape not html_escaped. `unescaped` is deprecated now
18-
* `video` has no more magic creation of source tag or automatically fetch asset path to keep dsl as close to html as possible
19-
* removed alias `pg` for `paragraph`
20-
* `rails_view` is replaced by `rails_render`. Use `rails_render partial: '/some_partial', locals: { foo: 1 }; rails_render file: '/some_view', locals: { foo: 1 }` to render a partial or a file or anything you want. Use the same as you would use rails `render`
21-
22-
* `Matestack::Ui::Core::Component::Registry.register_components` Registry was removed. Write a module with methods to use your components via methods
23-
24-
* an app now defines the complete layout, including the head, scripts, csrf tags etc.
25-
26-
* `transition` can no longer handle symbols as path. Use rails path helper instead
27-
28-
* `Matestack::Ui::DynamicActionviewComponent, Matestack::Ui::Core::Actionview::Dynamic` and static removed -> is not needed
29-
30-
* slots api has changed. Always use `method(:your_slot_method)` to pass slots into another component. Use `slot :your_slot` to render the slot. Pass optional params to slots in order to use with your method `slot :your_slot, 'A param'`.
31-
32-
* Properties are now accessed via a context `context` or short `ctx`. Access your defined `required` or `optional` properties via `ctx.your_property`
33-
* `requires` is deprecated please use `required`
34-
35-
* Slots given with a :slots key are accessible trough a slots method, but you can use custom properties to also use slots. Recommended to always use :slots param for better encapsulating slots from params.
36-
37-
* You can pass a component an argument and options like `header 'Your headline', color: :blue`. Access it now with `self.text # or text` instead of `@argument`
38-
39-
* `isolate` doesn't raise 'not authorized' anymore. When isolate is not authorized no content is returned. Only a warning is logged to the console
40-
41-
* implicit rendering in a controller does not work anymore. Specify the page in a render call
42-
43-
* `link` removed -> now renders usual html link tag
44-
45-
46-
TODOS
47-
* at the moment there is no rendering of a "default app" when no matestack app is specified
5+
Please refer to the [migration guide](./docs/migrate-from-1.x-to-2.0.md)
486

497
## v1.5.0 Release - 2021-03-07
508

docs/SUMMARY.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Table of contents
22

33
* [Welcome](README.md)
4-
* [Migrating from 1.x to 2.0 \[WIP\]](migrate-from-1.x-to-2.0-wip.md)
4+
* [Migrating from 1.x to 2.0](migrate-from-1.x-to-2.0.md)
55

66
## Getting started
77

@@ -90,4 +90,3 @@
9090
* [Core Team \[WIP\]](about/team.md)
9191
* [Sponsoring \[WIP\]](about/sponsoring-wip.md)
9292
* [Legal Details \[WIP\]](about/legal-details-wip.md)
93-

0 commit comments

Comments
 (0)