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.

Sign up for GitHub

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

Jump to bottom

Minor readme fixes #28

Merged
merged 3 commits into from
Feb 23, 2024
Merged

Minor readme fixes #28

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b026b4
Don't end sentence with colon if not necessary
tbrlpld Feb 23, 2024
f2664e4
Fix typo
tbrlpld Feb 23, 2024
a058829
Add emoji
tbrlpld Feb 23, 2024
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
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Laces
# Laces 👟

[![License: BSD-3-Clause](https://img.shields.io/github/license/tbrlpld/laces)](https://github.com/tbrlpld/laces/blob/main/LICENSE)
[![PyPI version](https://img.shields.io/pypi/v/laces)](https://pypi.org/project/laces/)
Expand Down Expand Up @@ -219,9 +219,10 @@ A couple more examples of how components can be used can be found [below](#patte
#### Using the parent context

You may have noticed in the above examples that the `render_html` and `get_context_data` methods take a `parent_context` argument.
This is the context of the template that is calling the component.
This is the context of the template that is rendering the component.
The `parent_context` is passed into the `render_html` method by the `{% component %}` template tag.
In the default implementation of the `render_html` method, the `parent_context` is then passed to the `get_context_data` method.

In the default implementation of the `render_html` method, the `parent_context` is passed to the `get_context_data` method.
The default implementation of the `get_context_data` method, however, ignores the `parent_context` argument and returns an empty dictionary.
To make use of it, you will have to override the `get_context_data` method.

Expand Down Expand Up @@ -289,7 +290,7 @@ Specifically, the keywords `with`, `only` and `as` are supported, similar to how

#### Provide additional parent context variables with `with`

You can pass additional parent context variables to the component using the keyword `with`:
You can pass additional parent context variables to the component using the `with` keyword.

```html+django
{% component welcome with name=request.user.first_name %}
Expand All @@ -301,7 +302,7 @@ For more information see the above section on the [parent context](#using-the-pa

#### Limit the parent context variables with `only`

To limit the parent context variables passed to the component to only those variables provided by the `with` keyword (and no others from the calling template's context), use `only`:
To limit the parent context variables passed to the component to only those variables provided by the `with` keyword (and no others from the calling template's context), use `only`.

```html+django
{% component welcome with name=request.user.first_name only %}
Expand All @@ -311,7 +312,7 @@ To limit the parent context variables passed to the component to only those vari

#### Store the rendered output in a variable with `as`

To store the component's rendered output in a variable rather than outputting it immediately, use `as` followed by the variable name:
To store the component's rendered output in a variable rather than outputting it immediately, use `as` followed by the variable name.

```html+django
{% component welcome as welcome_html %}
Expand Down Expand Up @@ -367,7 +368,7 @@ Once you have defined the assets on the component in one of the two ways above,
This, again, works in the same way as it does for Django form widgets.
The component instance will have a `media` property which returns an instance of the `django.forms.Media` class.
This is the case, even if you used the nested `Media` class to define the assets.
The [string representation of a `Media` objects](https://docs.djangoproject.com/en/5.0/topics/forms/media#s-media-objects) are the HTML declarations to include the assets.
The [string representation of `Media` objects](https://docs.djangoproject.com/en/5.0/topics/forms/media#s-media-objects) are the HTML declarations to include the assets.

In the example home template from above, we can output the component's media declarations like so:

Expand Down
Loading