django-components 0.136__tar.gz → 0.138__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {django_components-0.136/src/django_components.egg-info → django_components-0.138}/PKG-INFO +180 -50
- {django_components-0.136 → django_components-0.138}/README.md +178 -48
- {django_components-0.136 → django_components-0.138}/pyproject.toml +2 -2
- {django_components-0.136 → django_components-0.138}/src/django_components/__init__.py +18 -4
- {django_components-0.136 → django_components-0.138}/src/django_components/app_settings.py +3 -1
- {django_components-0.136 → django_components-0.138}/src/django_components/compat/django.py +4 -4
- {django_components-0.136 → django_components-0.138}/src/django_components/component.py +141 -26
- {django_components-0.136 → django_components-0.138}/src/django_components/component_registry.py +1 -1
- {django_components-0.136 → django_components-0.138}/src/django_components/dependencies.py +37 -54
- {django_components-0.136 → django_components-0.138}/src/django_components/extension.py +169 -38
- django_components-0.138/src/django_components/extensions/cache.py +140 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/extensions/defaults.py +20 -0
- django_components-0.138/src/django_components/extensions/url.py +181 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/extensions/view.py +26 -17
- {django_components-0.136 → django_components-0.138}/src/django_components/util/command.py +15 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/misc.py +3 -2
- {django_components-0.136 → django_components-0.138}/src/django_components/util/routing.py +15 -2
- {django_components-0.136 → django_components-0.138}/src/django_components/util/testing.py +15 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/types.py +3 -2
- {django_components-0.136 → django_components-0.138/src/django_components.egg-info}/PKG-INFO +180 -50
- {django_components-0.136 → django_components-0.138}/src/django_components.egg-info/SOURCES.txt +2 -0
- {django_components-0.136 → django_components-0.138}/LICENSE +0 -0
- {django_components-0.136 → django_components-0.138}/MANIFEST.in +0 -0
- {django_components-0.136 → django_components-0.138}/setup.cfg +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/apps.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/attributes.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/autodiscovery.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/cache.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/components.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/create.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/ext.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/ext_list.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/ext_run.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/list.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/startcomponent.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/upgrade.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/commands/upgradecomponent.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/compat/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/component_media.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/components/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/components/dynamic.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/context.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/expression.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/extensions/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/finders.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/library.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/management/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/management/commands/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/management/commands/components.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/management/commands/startcomponent.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/management/commands/upgradecomponent.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/middleware.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/node.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/perfutil/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/perfutil/component.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/perfutil/provide.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/provide.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/py.typed +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/slots.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/static/django_components/django_components.min.js +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/tag_formatter.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/template.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/template_loader.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/templatetags/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/templatetags/component_tags.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/testing.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/types.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/urls.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/__init__.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/cache.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/component_highlight.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/context.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/django_monkeypatch.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/exception.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/loader.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/logger.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/nanoid.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/tag_parser.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/template_parser.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/template_tag.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components/util/weakref.py +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components.egg-info/dependency_links.txt +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components.egg-info/requires.txt +0 -0
- {django_components-0.136 → django_components-0.138}/src/django_components.egg-info/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: django_components
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.138
|
|
4
4
|
Summary: A way to create simple reusable template components in Django.
|
|
5
5
|
Author-email: Emil Stenström <emil@emilstenstrom.se>
|
|
6
6
|
License: MIT
|
|
@@ -12,8 +12,8 @@ Project-URL: Donate, https://github.com/sponsors/EmilStenstrom
|
|
|
12
12
|
Keywords: django,components,css,js,html
|
|
13
13
|
Classifier: Framework :: Django
|
|
14
14
|
Classifier: Framework :: Django :: 4.2
|
|
15
|
-
Classifier: Framework :: Django :: 5.0
|
|
16
15
|
Classifier: Framework :: Django :: 5.1
|
|
16
|
+
Classifier: Framework :: Django :: 5.2
|
|
17
17
|
Classifier: Operating System :: OS Independent
|
|
18
18
|
Classifier: Programming Language :: Python
|
|
19
19
|
Classifier: Programming Language :: Python :: 3
|
|
@@ -165,9 +165,11 @@ class Calendar(Component):
|
|
|
165
165
|
|
|
166
166
|
### Composition with slots
|
|
167
167
|
|
|
168
|
-
- Render components inside templates with
|
|
169
|
-
|
|
170
|
-
-
|
|
168
|
+
- Render components inside templates with
|
|
169
|
+
[`{% component %}`](https://django-components.github.io/django-components/latest/reference/template_tags#component) tag.
|
|
170
|
+
- Compose them with [`{% slot %}`](https://django-components.github.io/django-components/latest/reference/template_tags#slot)
|
|
171
|
+
and [`{% fill %}`](https://django-components.github.io/django-components/latest/reference/template_tags#fill) tags.
|
|
172
|
+
- Vue-like slot system, including [scoped slots](https://django-components.github.io/django-components/latest/concepts/fundamentals/slots/#scoped-slots).
|
|
171
173
|
|
|
172
174
|
```django
|
|
173
175
|
{% component "Layout"
|
|
@@ -201,14 +203,17 @@ class Calendar(Component):
|
|
|
201
203
|
|
|
202
204
|
### Extended template tags
|
|
203
205
|
|
|
204
|
-
`django-components`
|
|
206
|
+
`django-components` is designed for flexibility, making working with templates a breeze.
|
|
205
207
|
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
-
|
|
210
|
-
-
|
|
211
|
-
-
|
|
208
|
+
It extends Django's template tags syntax with:
|
|
209
|
+
|
|
210
|
+
<!-- TODO - Document literal lists and dictionaries -->
|
|
211
|
+
- Literal lists and dictionaries in the template
|
|
212
|
+
- [Self-closing tags](https://django-components.github.io/django-components/latest/concepts/fundamentals/template_tag_syntax#self-closing-tags) `{% mytag / %}`
|
|
213
|
+
- [Multi-line template tags](https://django-components.github.io/django-components/latest/concepts/fundamentals/template_tag_syntax#multiline-tags)
|
|
214
|
+
- [Spread operator](https://django-components.github.io/django-components/latest/concepts/fundamentals/template_tag_syntax#spread-operator) `...` to dynamically pass args or kwargs into the template tag
|
|
215
|
+
- [Template tags inside literal strings](https://django-components.github.io/django-components/latest/concepts/fundamentals/template_tag_syntax#template-tags-inside-literal-strings) like `"{{ first_name }} {{ last_name }}"`
|
|
216
|
+
- [Pass dictonaries by their key-value pairs](https://django-components.github.io/django-components/latest/concepts/fundamentals/template_tag_syntax#pass-dictonary-by-its-key-value-pairs) `attr:key=val`
|
|
212
217
|
|
|
213
218
|
```django
|
|
214
219
|
{% component "table"
|
|
@@ -233,13 +238,70 @@ class Calendar(Component):
|
|
|
233
238
|
/ %}
|
|
234
239
|
```
|
|
235
240
|
|
|
241
|
+
You too can define template tags with these features by using
|
|
242
|
+
[`@template_tag()`](https://django-components.github.io/django-components/latest/reference/api/#django_components.template_tag)
|
|
243
|
+
or [`BaseNode`](https://django-components.github.io/django-components/latest/reference/api/#django_components.BaseNode).
|
|
244
|
+
|
|
245
|
+
Read more on [Custom template tags](https://django-components.github.io/django-components/latest/concepts/advanced/template_tags/).
|
|
246
|
+
|
|
247
|
+
### Full programmatic access
|
|
248
|
+
|
|
249
|
+
When you render a component, you can access everything about the component:
|
|
250
|
+
|
|
251
|
+
- Component input: [args, kwargs, slots and context](https://django-components.github.io/django-components/latest/concepts/fundamentals/render_api/#component-inputs)
|
|
252
|
+
- Component's template, CSS and JS
|
|
253
|
+
- Django's [context processors](https://django-components.github.io/django-components/latest/concepts/fundamentals/render_api/#request-object-and-context-processors)
|
|
254
|
+
- Unique [render ID](https://django-components.github.io/django-components/latest/concepts/fundamentals/render_api/#component-id)
|
|
255
|
+
|
|
256
|
+
```python
|
|
257
|
+
class Table(Component):
|
|
258
|
+
js_file = "table.js"
|
|
259
|
+
css_file = "table.css"
|
|
260
|
+
|
|
261
|
+
template = """
|
|
262
|
+
<div class="table">
|
|
263
|
+
<span>{{ variable }}</span>
|
|
264
|
+
</div>
|
|
265
|
+
"""
|
|
266
|
+
|
|
267
|
+
def get_context_data(self, var1, var2, variable, another, **attrs):
|
|
268
|
+
# Access component's ID
|
|
269
|
+
assert self.id == "djc1A2b3c"
|
|
270
|
+
|
|
271
|
+
# Access component's inputs and slots
|
|
272
|
+
assert self.input.args == (123, "str")
|
|
273
|
+
assert self.input.kwargs == {"variable": "test", "another": 1}
|
|
274
|
+
footer_slot = self.input.slots["footer"]
|
|
275
|
+
some_var = self.input.context["some_var"]
|
|
276
|
+
|
|
277
|
+
# Access the request object and Django's context processors, if available
|
|
278
|
+
assert self.request.GET == {"query": "something"}
|
|
279
|
+
assert self.context_processors_data['user'].username == "admin"
|
|
280
|
+
|
|
281
|
+
return {
|
|
282
|
+
"variable": variable,
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
# Access component's HTML / JS / CSS
|
|
286
|
+
Table.template
|
|
287
|
+
Table.js
|
|
288
|
+
Table.css
|
|
289
|
+
|
|
290
|
+
# Render the component
|
|
291
|
+
rendered = Table.render(
|
|
292
|
+
kwargs={"variable": "test", "another": 1},
|
|
293
|
+
args=(123, "str"),
|
|
294
|
+
slots={"footer": "MY_FOOTER"},
|
|
295
|
+
)
|
|
296
|
+
```
|
|
297
|
+
|
|
236
298
|
### Granular HTML attributes
|
|
237
299
|
|
|
238
300
|
Use the [`{% html_attrs %}`](https://django-components.github.io/django-components/latest/concepts/fundamentals/html_attributes/) template tag to render HTML attributes.
|
|
301
|
+
|
|
239
302
|
It supports:
|
|
240
303
|
|
|
241
|
-
- Defining attributes as dictionaries
|
|
242
|
-
- Defining attributes as keyword arguments
|
|
304
|
+
- Defining attributes as whole dictionaries or keyword arguments
|
|
243
305
|
- Merging attributes from multiple sources
|
|
244
306
|
- Boolean attributes
|
|
245
307
|
- Appending attributes
|
|
@@ -256,13 +318,19 @@ It supports:
|
|
|
256
318
|
>
|
|
257
319
|
```
|
|
258
320
|
|
|
259
|
-
`{% html_attrs %}` offers a Vue-like granular control
|
|
321
|
+
[`{% html_attrs %}`](https://django-components.github.io/django-components/latest/concepts/fundamentals/html_attributes/) offers a Vue-like granular control for
|
|
322
|
+
[`class`](https://django-components.github.io/django-components/latest/concepts/fundamentals/html_attributes/#merging-class-attributes)
|
|
323
|
+
and [`style`](https://django-components.github.io/django-components/latest/concepts/fundamentals/html_attributes/#merging-style-attributes)
|
|
324
|
+
HTML attributes,
|
|
260
325
|
where you can use a dictionary to manage each class name or style property separately.
|
|
261
326
|
|
|
262
327
|
```django
|
|
263
328
|
{% html_attrs
|
|
264
329
|
class="foo bar"
|
|
265
|
-
class={
|
|
330
|
+
class={
|
|
331
|
+
"baz": True,
|
|
332
|
+
"foo": False,
|
|
333
|
+
}
|
|
266
334
|
class="extra"
|
|
267
335
|
%}
|
|
268
336
|
```
|
|
@@ -270,7 +338,11 @@ where you can use a dictionary to manage each class name or style property separ
|
|
|
270
338
|
```django
|
|
271
339
|
{% html_attrs
|
|
272
340
|
style="text-align: center; background-color: blue;"
|
|
273
|
-
style={
|
|
341
|
+
style={
|
|
342
|
+
"background-color": "green",
|
|
343
|
+
"color": None,
|
|
344
|
+
"width": False,
|
|
345
|
+
}
|
|
274
346
|
style="position: absolute; height: 12px;"
|
|
275
347
|
%}
|
|
276
348
|
```
|
|
@@ -281,9 +353,11 @@ Read more about [HTML attributes](https://django-components.github.io/django-com
|
|
|
281
353
|
|
|
282
354
|
`django-components` makes integration with HTMX, AlpineJS or jQuery easy by allowing components to be rendered as HTML fragments:
|
|
283
355
|
|
|
284
|
-
- Components's JS and CSS
|
|
356
|
+
- Components's JS and CSS files are loaded automatically when the fragment is inserted into the DOM.
|
|
357
|
+
|
|
358
|
+
- Components can be [exposed as Django Views](https://django-components.github.io/django-components/latest/concepts/fundamentals/component_views_urls/) with `get()`, `post()`, `put()`, `patch()`, `delete()` methods
|
|
285
359
|
|
|
286
|
-
-
|
|
360
|
+
- Automatically create an endpoint for a component with [`Component.Url.public`](https://django-components.github.io/django-components/latest/concepts/fundamentals/component_views_urls/#register-urls-automatically)
|
|
287
361
|
|
|
288
362
|
```py
|
|
289
363
|
# components/calendar/calendar.py
|
|
@@ -291,30 +365,73 @@ Read more about [HTML attributes](https://django-components.github.io/django-com
|
|
|
291
365
|
class Calendar(Component):
|
|
292
366
|
template_file = "calendar.html"
|
|
293
367
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
)
|
|
368
|
+
# Register Component with `urlpatterns`
|
|
369
|
+
class Url:
|
|
370
|
+
public = True
|
|
371
|
+
|
|
372
|
+
# Define handlers
|
|
373
|
+
class View:
|
|
374
|
+
def get(self, request, *args, **kwargs):
|
|
375
|
+
page = request.GET.get("page", 1)
|
|
376
|
+
return self.component.render_to_response(
|
|
377
|
+
request=request,
|
|
378
|
+
kwargs={
|
|
379
|
+
"page": page,
|
|
380
|
+
},
|
|
381
|
+
)
|
|
301
382
|
|
|
302
383
|
def get_context_data(self, page):
|
|
303
384
|
return {
|
|
304
385
|
"page": page,
|
|
305
386
|
}
|
|
306
387
|
|
|
307
|
-
#
|
|
308
|
-
|
|
388
|
+
# Get auto-generated URL for the component
|
|
389
|
+
url = get_component_url(Calendar)
|
|
390
|
+
|
|
391
|
+
# Or define explicit URL in urls.py
|
|
392
|
+
path("calendar/", Calendar.as_view())
|
|
309
393
|
```
|
|
310
394
|
|
|
311
|
-
###
|
|
395
|
+
### Provide / Inject
|
|
396
|
+
|
|
397
|
+
`django-components` supports the provide / inject pattern, similarly to React's [Context Providers](https://react.dev/learn/passing-data-deeply-with-context) or Vue's [provide / inject](https://vuejs.org/guide/components/provide-inject):
|
|
398
|
+
|
|
399
|
+
- Use the [`{% provide %}`](https://django-components.github.io/django-components/latest/reference/template_tags/#provide) tag to provide data to the component tree
|
|
400
|
+
- Use the [`Component.inject()`](https://django-components.github.io/django-components/latest/reference/api/#django_components.Component.inject) method to inject data into the component
|
|
312
401
|
|
|
313
|
-
|
|
402
|
+
Read more about [Provide / Inject](https://django-components.github.io/django-components/latest/concepts/advanced/provide_inject).
|
|
403
|
+
|
|
404
|
+
```django
|
|
405
|
+
<body>
|
|
406
|
+
{% provide "theme" variant="light" %}
|
|
407
|
+
{% component "header" / %}
|
|
408
|
+
{% endprovide %}
|
|
409
|
+
</body>
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
```djc_py
|
|
413
|
+
@register("header")
|
|
414
|
+
class Header(Component):
|
|
415
|
+
template = "..."
|
|
416
|
+
|
|
417
|
+
def get_context_data(self, *args, **kwargs):
|
|
418
|
+
theme = self.inject("theme").variant
|
|
419
|
+
return {
|
|
420
|
+
"theme": theme,
|
|
421
|
+
}
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
### Static type hints
|
|
425
|
+
|
|
426
|
+
Components API is fully typed, and supports [static type hints](https://django-components.github.io/django-components/latest/concepts/advanced/typing_and_validation/).
|
|
427
|
+
|
|
428
|
+
To opt-in to static type hints, define types for component's args, kwargs, slots, and more:
|
|
314
429
|
|
|
315
430
|
```py
|
|
316
431
|
from typing import NotRequired, Tuple, TypedDict, SlotContent, SlotFunc
|
|
317
432
|
|
|
433
|
+
from django_components import Component
|
|
434
|
+
|
|
318
435
|
ButtonArgs = Tuple[int, str]
|
|
319
436
|
|
|
320
437
|
class ButtonKwargs(TypedDict):
|
|
@@ -340,7 +457,10 @@ class Button(ButtonType):
|
|
|
340
457
|
return {} # Error: Key "variable" is missing
|
|
341
458
|
```
|
|
342
459
|
|
|
343
|
-
When you then call
|
|
460
|
+
When you then call
|
|
461
|
+
[`Button.render()`](https://django-components.github.io/django-components/latest/reference/api/#django_components.Component.render) or
|
|
462
|
+
[`Button.render_to_response()`](https://django-components.github.io/django-components/latest/reference/api/#django_components.Component.render_to_response),
|
|
463
|
+
you will get type hints:
|
|
344
464
|
|
|
345
465
|
```py
|
|
346
466
|
Button.render(
|
|
@@ -355,37 +475,56 @@ Button.render(
|
|
|
355
475
|
|
|
356
476
|
### Extensions
|
|
357
477
|
|
|
358
|
-
Django-components functionality can be extended with
|
|
478
|
+
Django-components functionality can be extended with [Extensions](https://django-components.github.io/django-components/latest/concepts/advanced/extensions/).
|
|
479
|
+
Extensions allow for powerful customization and integrations. They can:
|
|
359
480
|
|
|
360
|
-
- Tap into lifecycle events, such as when a component is created, deleted, or registered
|
|
361
|
-
- Add new attributes and methods to the components
|
|
362
|
-
- Add custom CLI commands
|
|
363
|
-
- Add custom URLs
|
|
481
|
+
- Tap into lifecycle events, such as when a component is created, deleted, or registered
|
|
482
|
+
- Add new attributes and methods to the components
|
|
483
|
+
- Add custom CLI commands
|
|
484
|
+
- Add custom URLs
|
|
364
485
|
|
|
365
486
|
Some of the extensions include:
|
|
366
487
|
|
|
488
|
+
- [Component caching](https://github.com/django-components/django-components/blob/master/src/django_components/extensions/cache.py)
|
|
367
489
|
- [Django View integration](https://github.com/django-components/django-components/blob/master/src/django_components/extensions/view.py)
|
|
368
490
|
- [Component defaults](https://github.com/django-components/django-components/blob/master/src/django_components/extensions/defaults.py)
|
|
369
491
|
- [Pydantic integration (input validation)](https://github.com/django-components/djc-ext-pydantic)
|
|
370
492
|
|
|
371
493
|
Some of the planned extensions include:
|
|
372
494
|
|
|
373
|
-
- Caching
|
|
374
495
|
- AlpineJS integration
|
|
375
496
|
- Storybook integration
|
|
376
497
|
- Component-level benchmarking with asv
|
|
377
498
|
|
|
499
|
+
### Caching
|
|
500
|
+
|
|
501
|
+
- [Components can be cached](https://django-components.github.io/django-components/latest/concepts/advanced/component_caching/) using Django's cache framework.
|
|
502
|
+
- Caching rules can be configured on a per-component basis.
|
|
503
|
+
- Components are cached based on their input. Or you can write custom caching logic.
|
|
504
|
+
|
|
505
|
+
```py
|
|
506
|
+
from django_components import Component
|
|
507
|
+
|
|
508
|
+
class MyComponent(Component):
|
|
509
|
+
class Cache:
|
|
510
|
+
enabled = True
|
|
511
|
+
ttl = 60 * 60 * 24 # 1 day
|
|
512
|
+
|
|
513
|
+
def hash(self, *args, **kwargs):
|
|
514
|
+
return hash(f"{json.dumps(args)}:{json.dumps(kwargs)}")
|
|
515
|
+
```
|
|
516
|
+
|
|
378
517
|
### Simple testing
|
|
379
518
|
|
|
380
|
-
- Write tests for components with `@djc_test` decorator.
|
|
519
|
+
- Write tests for components with [`@djc_test`](https://django-components.github.io/django-components/latest/concepts/advanced/testing/) decorator.
|
|
381
520
|
- The decorator manages global state, ensuring that tests don't leak.
|
|
382
521
|
- If using `pytest`, the decorator allows you to parametrize Django or Components settings.
|
|
383
|
-
- The decorator also serves as a stand-in for Django's `@override_settings
|
|
522
|
+
- The decorator also serves as a stand-in for Django's [`@override_settings`](https://docs.djangoproject.com/en/5.2/topics/testing/tools/#django.test.override_settings).
|
|
384
523
|
|
|
385
524
|
```python
|
|
386
|
-
from
|
|
525
|
+
from django_components.testing import djc_test
|
|
387
526
|
|
|
388
|
-
from components.
|
|
527
|
+
from components.my_table import MyTable
|
|
389
528
|
|
|
390
529
|
@djc_test
|
|
391
530
|
def test_my_table():
|
|
@@ -397,11 +536,6 @@ def test_my_table():
|
|
|
397
536
|
assert rendered == "<table>My table</table>"
|
|
398
537
|
```
|
|
399
538
|
|
|
400
|
-
### Handle large projects with ease
|
|
401
|
-
|
|
402
|
-
- Components can be infinitely nested.
|
|
403
|
-
- (Soon) Optimize performance with component-level caching
|
|
404
|
-
|
|
405
539
|
### Debugging features
|
|
406
540
|
|
|
407
541
|
- **Visual component inspection**: Highlight components and slots directly in your browser.
|
|
@@ -425,10 +559,6 @@ def test_my_table():
|
|
|
425
559
|
{% endcalendar %}
|
|
426
560
|
```
|
|
427
561
|
|
|
428
|
-
### Other features
|
|
429
|
-
|
|
430
|
-
- Vue-like provide / inject system
|
|
431
|
-
|
|
432
562
|
## Documentation
|
|
433
563
|
|
|
434
564
|
[Read the full documentation here](https://django-components.github.io/django-components/latest/).
|