Skip to content

Commit 597d71b

Browse files
update roadmap
1 parent bbf7359 commit 597d71b

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

ROADMAP.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,21 @@ Below are a bunch of features I'd like to bring to django-bird.
44

55
I have included code snippets where applicable, but they are back-of-the-napkin sketches of potential APIs -- subject to change if and when the feature is actually introduced.
66

7-
## Static Asset Collection
7+
## Static Asset Collection 🏗️
8+
9+
> [!NOTE]
10+
> django-bird [v0.6.0](https://github.com/joshuadavidthomas/django-bird/releases/tag/v0.6.0) introduced automatic asset management via `{% bird:css %}` and `{% bird:js %}` templatetags. The current implementation automatically discovers and loads CSS and JS files that match your component names:
11+
>
12+
> ```bash
13+
> templates/bird/button/
14+
> ├── button.css # Automatically loaded by {% bird:css %}
15+
> ├── button.html # Component template
16+
> └── button.js # Automatically loaded by {% bird:js %}
17+
> ```
18+
>
19+
> Future versions should eventually add support for inline styles and scripts with proper component scoping, compilation, and bundling.
20+
>
21+
> See the [docs](https://django-bird.readthedocs.io/en/latest/assets.html) for more information.
822
923
This is table stakes for a modern Django template component library. The goal is to allow you to define CSS and JS for a component and have it loaded automatically when you use that component.
1024
@@ -113,6 +127,14 @@ To give you an idea of what the final compiled output might look like, here's a
113127
</html>
114128
```
115129
130+
> **Update, 2024-12-03**
131+
> The current implementation handles basic asset discovery and loading, but future enhancements will include:
132+
>
133+
> - Inline style and script support with component scoping
134+
> - Asset compilation and bundling
135+
> - The `$bird` variable for component-specific JavaScript
136+
> - CSS scoping via data attributes
137+
116138
## Overriding Default Attributes ✅
117139
118140
> [!NOTE]

0 commit comments

Comments
 (0)