Skip to content

Commit 78823ee

Browse files
authored
v1.2.0 (#97)
1 parent 9069952 commit 78823ee

File tree

5 files changed

+13
-8
lines changed

5 files changed

+13
-8
lines changed

Diff for: CHANGELOG.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Using the following categories, list your changes in this order:
2222

2323
## [Unreleased]
2424

25+
- Nothing (Yet)
26+
27+
## [1.2.0] - 2022-09-19
28+
2529
### Added
2630

2731
- `auth_required` decorator to prevent your components from rendering to unauthenticated users.
@@ -32,6 +36,7 @@ Using the following categories, list your changes in this order:
3236
### Changed
3337

3438
- Bumped the minimum IDOM version to 0.40.2
39+
- Testing suite now uses `playwright` instead of `selenium`
3540

3641
### Fixed
3742

@@ -125,7 +130,8 @@ Using the following categories, list your changes in this order:
125130

126131
- Support for IDOM within the Django
127132

128-
[unreleased]: https://github.com/idom-team/django-idom/compare/1.0.0...HEAD
133+
[unreleased]: https://github.com/idom-team/django-idom/compare/1.2.0...HEAD
134+
[1.2.0]: https://github.com/idom-team/django-idom/compare/1.1.0...1.2.0
129135
[1.1.0]: https://github.com/idom-team/django-idom/compare/1.0.0...1.1.0
130136
[1.0.0]: https://github.com/idom-team/django-idom/compare/0.0.5...1.0.0
131137
[0.0.5]: https://github.com/idom-team/django-idom/compare/0.0.4...0.0.5

Diff for: docs/src/contribute/django-idom.md

-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ If you plan to make code changes to this repository, you'll need to install the
77
- [Python 3.8+](https://www.python.org/downloads/)
88
- [Git](https://git-scm.com/downloads)
99
- [NPM](https://docs.npmjs.com/try-the-latest-stable-version-of-npm) for installing and managing Javascript
10-
- [ChromeDriver](https://chromedriver.chromium.org/downloads) for testing with [Selenium](https://www.seleniumhq.org/)
1110

1211
Once done, you should clone this repository:
1312

Diff for: docs/src/features/components.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Convert any Django view into a IDOM component by usng this decorator. Compatible
2727
| Name | Type | Description | Default |
2828
| --- | --- | --- | --- |
2929
| view | `Callable | View` | The view function or class to convert. | N/A |
30-
| compatibility | `bool` | If True, the component will be rendered in an iframe. Strict parsing does not apply to compatibility mode. | `False` |
30+
| compatibility | `bool` | If True, the component will be rendered in an iframe. When using compatibility mode `tranforms`, `strict_parsing`, and `request` arguments will be ignored. | `False` |
3131
| transforms | `Iterable[Callable[[VdomDict], Any]]` | A list of functions that transforms the newly generated VDOM. The functions will be called on each VDOM node. | `tuple` |
3232
| strict_parsing | `bool` | If True, an exception will be generated if the HTML does not perfectly adhere to HTML5. | `True` |
33-
| request | `HttpRequest | None` | Request object to provide to the view. Custom request objects cannot be used in compatibility mode. | `None` |
33+
| request | `HttpRequest | None` | Request object to provide to the view. | `None` |
3434
| args | `Iterable` | The positional arguments to pass to the view. | `tuple` |
3535
| kwargs | `Dict | None` | The keyword arguments to pass to the view. | `None` |
3636

@@ -93,7 +93,7 @@ Convert any Django view into a IDOM component by usng this decorator. Compatible
9393

9494
For views that rely on HTTP responses other than `GET` (such as `PUT`, `POST`, `PATCH`, etc), you should consider using compatibility mode to render your view within an iframe.
9595

96-
Any view can be rendered within compatibility mode. However, the `strict_parsing` argument does not apply to compatibility mode.
96+
Any view can be rendered within compatibility mode. However, the `transforms`, `strict_parsing`, and `request` arguments do not apply to compatibility mode.
9797

9898
Please note that by default the iframe is unstyled, and thus won't look pretty until you add some CSS.
9999

Diff for: src/django_idom/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from django_idom.websocket.paths import IDOM_WEBSOCKET_PATH
44

55

6-
__version__ = "1.1.0"
6+
__version__ = "1.2.0"
77
__all__ = [
88
"IDOM_WEBSOCKET_PATH",
99
"IdomWebsocket",

Diff for: src/django_idom/components.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ def view_to_component(
3636
3737
Keyword Args:
3838
compatibility: If True, the component will be rendered in an iframe.
39-
Strict parsing does not apply to compatibility mode.
39+
When using compatibility mode `tranforms`, `strict_parsing`, and `request`
40+
arguments will be ignored.
4041
transforms: A list of functions that transforms the newly generated VDOM.
4142
The functions will be called on each VDOM node.
4243
strict_parsing: If True, an exception will be generated if the HTML does not
4344
perfectly adhere to HTML5.
4445
request: Request object to provide to the view.
45-
Custom request objects cannot be used in compatibility mode.
4646
args: The positional arguments to pass to the view.
4747
kwargs: The keyword arguments to pass to the view.
4848
"""

0 commit comments

Comments
 (0)