feat: Publish & Document Jinja Macros #5342

jmuzina · 2024-09-11T19:03:46Z

Done

Feature branch PR for publishing & documenting Jinja macros

QA

See QA instructions on the above PRs if you want to re-QA the feature PR.

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

PR should have one of the following labels to automatically categorise it in release notes:
- Feature 🎁, Breaking Change 💣, Bug 🐛, Documentation 📝, Maintenance 🔨.
Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
- if CSS class names are not changed it can be bugfix release (x.x.X)
- if CSS class names are changed/added/removed it should be minor version (x.X.0)
- see the wiki for more details
Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.

webteam-app · 2024-09-11T19:03:50Z

Demo

Jenkins

demos.haus

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

@pastelcyborg

* Add macro install instructions to docs pages (#5330) * Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md * Add macros directory to published files * Rename hero macro * Rename tiered list macro * Update releases.yml * End hero title and subtitle params with _text per new naming convention * Add html block comments to hero macro * Add hero macro docn * Add Hero macro import instructions * Add link to @pastelcyborg jinja macros installation guide * Fix hero title_text being renamed from rebase * Adjust jinja parameters column order * lowercase param types * adjust slots column ordering * Adjust slots is required per code review * Markup params table * Markup slots table * parameter & slot tables horizontally scroll rather than using mobile cards * Param/slot table widths set by percentage * More consistent whitespace control chars around jinja macro import * Revise hero element/description table word choice around title/substitle/description * comma-separated string with line breaks for hero layout type options * Update is required column by @bartaz Co-authored-by: Bartek Szopka <[email protected]> * Code review suggestions from @bartaz Co-authored-by: Bartek Szopka <[email protected]> --------- Co-authored-by: pastelcyborg <[email protected]> Co-authored-by: Bartek Szopka <[email protected]>

@pastelcyborg

* Add macro install instructions to docs pages (#5330) * Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md * Add macros directory to published files * Rename hero macro * Rename tiered list macro * Update releases.yml * End hero title and subtitle params with _text per new naming convention * Add html block comments to hero macro * Add hero macro docn * Add Hero macro import instructions * Add link to @pastelcyborg jinja macros installation guide * Fix hero title_text being renamed from rebase * Adjust jinja parameters column order * lowercase param types * adjust slots column ordering * Adjust slots is required per code review * Markup params table * Markup slots table * parameter & slot tables horizontally scroll rather than using mobile cards * Param/slot table widths set by percentage * More consistent whitespace control chars around jinja macro import * Revise hero element/description table word choice around title/substitle/description * comma-separated string with line breaks for hero layout type options * Update is required column by @bartaz Co-authored-by: Bartek Szopka <[email protected]> * Code review suggestions from @bartaz Co-authored-by: Bartek Szopka <[email protected]> --------- Co-authored-by: pastelcyborg <[email protected]> Co-authored-by: Bartek Szopka <[email protected]>

…nja']

This reverts commit 75e51b8.

This reverts commit 99b32c9.

…rn them there instead of generating them in the callback

jmuzina added the Feature 🎁 New feature or request label Sep 11, 2024

jmuzina force-pushed the feature/expose-macros branch from 78a9b85 to 6c81e69 Compare September 11, 2024 19:07

jmuzina added the Priority: High Should be addressed within current iteration label Sep 19, 2024

pastelcyborg and others added 26 commits September 19, 2024 15:01

Add macro install instructions to docs pages (#5330)

7f8fe91

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

Add macros directory to published files

ca0f26f

Rename hero macro

02c5f8c

Rename tiered list macro

e38ca9d

Update releases.yml

fc5f5bc

Rename hero macro

3cad687

Update _index.scss

2af3d49

Update _index.scss

f007fee

Add tiered list docs; minor formatting updates

b65041b

File formatting fixes

55f4639

Change "call to action block" to "CTA block"

4203f61

Add cta block slot docs

24be19c

Add code comments

b222ce0

Apply static widths to table columns

bac567c

Add route for serving raw example template

8e14dcf

Render flask template in HTML code snippet

3233da0

Show rendered/raw example

5708eb6

Enable switching between Jinja code snippets and rendered HTML

2505aeb

Slight example.js docs improvements & refactors

02308cf

Run prettier

a5a842f

RM example guide

f7a007f

Switch jinja example trigger from .js-show-template to [data-lang='ji…

eb1ffe9

…nja']

Use raw query parameter instead of /example path

d9c5d28

Syntax-highlight HTML within Jinja template macro calls

7b7b4f8

jmuzina added 18 commits September 19, 2024 15:01

Revert "Move throttle() to a utils function"

cb1bf69

This reverts commit 75e51b8.

rename createPreCode param hide to isHidden

36893b4

Reapply "Move throttle() to a utils function"

fbcc112

This reverts commit 99b32c9.

swap xmlhttprequest for fetch()

4388d0d

Moved fetch code from example file into shared utils

0835ec5

Move utils to window scope, rather than JS import

27f4cdd

prettier

d5dcc0a

set no-cache on raw template endpoint

446ae7b

Re-remove extracted utils functions

dc85806

replace let with const where applicable

59b4d75

Additional try/catch handler in fetchResponse()

65325e8

renderdropdown guard

d205c94

promise.all parallelization improvement

d051e3d

rename EXAMPLE_OPTION_CFG to EXAMPLE_LANGUAGE_OPTION_CONFIG

138d2f8

Move HTML body extraction functions into fetchHtmlSource() and retu…

93bc882

…rn them there instead of generating them in the callback

rename fetchHtmlSource() to fetchRenderedHtml()

9cc3c3c

Switch default example language from HTML to jinja if jinja is found

9a2bca2

Clean up parallelization per code review

e995d6f

jmuzina force-pushed the feature/expose-macros branch from d7a5b37 to e995d6f Compare September 19, 2024 19:01

jmuzina added Review: QA needed Review: Code needed Review: Percy needed This PR needs a review of Percy for visual regressions labels Sep 19, 2024

Prepare macros for release (bump to 4.17.0)

c70de3b

jmuzina added Review: Percy +1 and removed Review: Percy needed This PR needs a review of Percy for visual regressions labels Sep 19, 2024

jmuzina changed the title ~~wip: feat: Publish & Document Jinja Macros~~ feat: Publish & Document Jinja Macros Sep 19, 2024

jmuzina marked this pull request as ready for review September 19, 2024 19:12

jmuzina requested review from bartaz, pastelcyborg and advl September 19, 2024 19:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Publish & Document Jinja Macros #5342

feat: Publish & Document Jinja Macros #5342

jmuzina commented Sep 11, 2024 •

edited

Loading

webteam-app commented Sep 11, 2024

feat: Publish & Document Jinja Macros #5342

Are you sure you want to change the base?

feat: Publish & Document Jinja Macros #5342

Conversation

jmuzina commented Sep 11, 2024 • edited Loading

Done

QA

Check if PR is ready for release

webteam-app commented Sep 11, 2024

Demo

Jenkins

demos.haus

jmuzina commented Sep 11, 2024 •

edited

Loading