loopwind 0.22.0 → 0.24.0
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.
- package/README.md +13 -117
- package/dist/cli.js +16 -10
- package/dist/cli.js.map +1 -1
- package/dist/commands/add.d.ts.map +1 -1
- package/dist/commands/add.js +6 -10
- package/dist/commands/add.js.map +1 -1
- package/dist/commands/agent.d.ts +8 -0
- package/dist/commands/agent.d.ts.map +1 -0
- package/dist/commands/agent.js +101 -0
- package/dist/commands/agent.js.map +1 -0
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +17 -7
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/render.d.ts.map +1 -1
- package/dist/commands/render.js +17 -19
- package/dist/commands/render.js.map +1 -1
- package/dist/default-templates/AGENTS.md +10 -24
- package/dist/lib/config.d.ts +2 -3
- package/dist/lib/config.d.ts.map +1 -1
- package/dist/lib/config.js +4 -9
- package/dist/lib/config.js.map +1 -1
- package/dist/lib/constants.d.ts +1 -3
- package/dist/lib/constants.d.ts.map +1 -1
- package/dist/lib/constants.js +2 -4
- package/dist/lib/constants.js.map +1 -1
- package/dist/lib/installer.d.ts +2 -0
- package/dist/lib/installer.d.ts.map +1 -1
- package/dist/lib/installer.js +6 -7
- package/dist/lib/installer.js.map +1 -1
- package/dist/lib/renderer.d.ts.map +1 -1
- package/dist/lib/renderer.js +14 -8
- package/dist/lib/renderer.js.map +1 -1
- package/dist/lib/resvg-init.d.ts +15 -0
- package/dist/lib/resvg-init.d.ts.map +1 -0
- package/dist/lib/resvg-init.js +55 -0
- package/dist/lib/resvg-init.js.map +1 -0
- package/dist/lib/tailwind/colors.d.ts +8 -0
- package/dist/lib/tailwind/colors.d.ts.map +1 -0
- package/dist/lib/tailwind/colors.js +102 -0
- package/dist/lib/tailwind/colors.js.map +1 -0
- package/dist/lib/tailwind/index.d.ts +10 -0
- package/dist/lib/tailwind/index.d.ts.map +1 -0
- package/dist/lib/tailwind/index.js +9 -0
- package/dist/lib/tailwind/index.js.map +1 -0
- package/dist/lib/tailwind/resolvers.d.ts +28 -0
- package/dist/lib/tailwind/resolvers.d.ts.map +1 -0
- package/dist/lib/tailwind/resolvers.js +94 -0
- package/dist/lib/tailwind/resolvers.js.map +1 -0
- package/dist/lib/tailwind/types.d.ts +29 -0
- package/dist/lib/tailwind/types.d.ts.map +1 -0
- package/dist/lib/tailwind/types.js +8 -0
- package/dist/lib/tailwind/types.js.map +1 -0
- package/dist/lib/tailwind-config-loader.d.ts +8 -45
- package/dist/lib/tailwind-config-loader.d.ts.map +1 -1
- package/dist/lib/tailwind-config-loader.js +6 -429
- package/dist/lib/tailwind-config-loader.js.map +1 -1
- package/dist/lib/tailwind.d.ts +1 -1
- package/dist/lib/tailwind.d.ts.map +1 -1
- package/dist/lib/tailwind.js +1 -1
- package/dist/lib/tailwind.js.map +1 -1
- package/dist/lib/utils.d.ts +13 -29
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +45 -155
- package/dist/lib/utils.js.map +1 -1
- package/dist/lib/video-renderer.d.ts.map +1 -1
- package/dist/lib/video-renderer.js +6 -5
- package/dist/lib/video-renderer.js.map +1 -1
- package/dist/types/config.d.ts +0 -2
- package/dist/types/config.d.ts.map +1 -1
- package/dist/types/config.js.map +1 -1
- package/package.json +2 -12
- package/REGISTRY_SETUP.md +0 -363
- package/_dsgn/templates/dashed-stroke-test/template.tsx +0 -73
- package/_dsgn/templates/path-follow-test/template.tsx +0 -176
- package/_dsgn/templates/path-simple-test/template.tsx +0 -98
- package/_dsgn/templates/stroke-dash-test/meta.json +0 -12
- package/_dsgn/templates/stroke-dash-test/template.tsx +0 -53
- package/dist/default-templates/image/template.d.ts +0 -20
- package/dist/default-templates/image/template.d.ts.map +0 -1
- package/dist/default-templates/image/template.js +0 -18
- package/dist/default-templates/image/template.js.map +0 -1
- package/dist/default-templates/image/template.tsx +0 -20
- package/dist/default-templates/kitchen-sink/template.tsx +0 -64
- package/dist/default-templates/page/template.tsx +0 -37
- package/dist/default-templates/video/template.d.ts +0 -26
- package/dist/default-templates/video/template.d.ts.map +0 -1
- package/dist/default-templates/video/template.js +0 -33
- package/dist/default-templates/video/template.js.map +0 -1
- package/dist/default-templates/video/template.tsx +0 -37
- package/dist/default-templates/website/pages/home.tsx +0 -17
- package/dist/default-templates/website/parts/footer.tsx +0 -17
- package/dist/default-templates/website/parts/header.tsx +0 -17
- package/dist/default-templates/website/template.tsx +0 -17
- package/dist/default-templates/website-template/pages/home.tsx +0 -13
- package/dist/default-templates/website-template/parts/footer.tsx +0 -15
- package/dist/default-templates/website-template/parts/header.tsx +0 -15
- package/dist/default-templates/website-template/template.tsx +0 -32
- package/dist/lib/encode-worker.d.ts +0 -2
- package/dist/lib/encode-worker.d.ts.map +0 -1
- package/dist/lib/encode-worker.js +0 -29
- package/dist/lib/encode-worker.js.map +0 -1
- package/dist/lib/mjpeg-muxer.d.ts +0 -46
- package/dist/lib/mjpeg-muxer.d.ts.map +0 -1
- package/dist/lib/mjpeg-muxer.js +0 -513
- package/dist/lib/mjpeg-muxer.js.map +0 -1
- package/dist/lib/tailwind-browser.d.ts +0 -27
- package/dist/lib/tailwind-browser.d.ts.map +0 -1
- package/dist/lib/tailwind-browser.js +0 -853
- package/dist/lib/tailwind-browser.js.map +0 -1
- package/dist/lib/video-player.d.ts +0 -25
- package/dist/lib/video-player.d.ts.map +0 -1
- package/dist/lib/video-player.js +0 -392
- package/dist/lib/video-player.js.map +0 -1
- package/dist/sdk/compiler.d.ts +0 -94
- package/dist/sdk/compiler.d.ts.map +0 -1
- package/dist/sdk/compiler.js +0 -122
- package/dist/sdk/compiler.js.map +0 -1
- package/dist/sdk/index.d.ts +0 -62
- package/dist/sdk/index.d.ts.map +0 -1
- package/dist/sdk/index.js +0 -141
- package/dist/sdk/index.js.map +0 -1
- package/dist/sdk/preview.d.ts +0 -65
- package/dist/sdk/preview.d.ts.map +0 -1
- package/dist/sdk/preview.js +0 -262
- package/dist/sdk/preview.js.map +0 -1
- package/dist/sdk/template.d.ts +0 -162
- package/dist/sdk/template.d.ts.map +0 -1
- package/dist/sdk/template.js +0 -231
- package/dist/sdk/template.js.map +0 -1
- package/examples/code-editor-templates.ts +0 -173
- package/examples/nextjs-api/README.md +0 -180
- package/examples/nextjs-api/package.json +0 -21
- package/examples/nextjs-api/pages/api/intro-video.ts +0 -53
- package/examples/nextjs-api/pages/api/og-image.ts +0 -50
- package/examples/nextjs-template-import.ts +0 -58
- package/examples/sdk-video-preview.tsx +0 -120
- package/examples/template-compiler-workflow.ts +0 -251
- package/examples/visual-builder-templates.ts +0 -336
- package/render-examples-600x400.mjs +0 -161
- package/render-spring-variants-fixed.mjs +0 -60
- package/render-staggered-text.mjs +0 -56
- package/test-font-files.mjs +0 -72
- package/test-jsx-support.mjs +0 -146
- package/test-sdk-config.mjs +0 -454
- package/test-sdk-source-config.mjs +0 -427
- package/test-sdk-user-templates.mjs +0 -469
- package/test-static-debug.tsx +0 -19
- package/test-templates/TESTS.md +0 -63
- package/test-templates/config-test.mjs +0 -17
- package/test-templates/demo-intro-props.json +0 -4
- package/test-templates/run-tests.sh +0 -44
- package/test-templates/test-sdk.mjs +0 -139
- package/test-video-props.json +0 -3
- package/website/.astro/content.db +0 -0
- package/website/.astro/integrations/_inox-tools_astro-when/types.d.ts +0 -1
- package/website/.astro/integrations/astro_db/db.d.ts +0 -15
- package/website/.astro/settings.json +0 -5
- package/website/.astro/types.d.ts +0 -2
- package/website/DEPLOYMENT.md +0 -143
- package/website/OG_IMAGES.md +0 -142
- package/website/README.md +0 -158
- package/website/astro.config.mjs +0 -46
- package/website/dist/.gitkeep +0 -5
- package/website/dist/_astro/agents.Yx-L_igG.css +0 -1
- package/website/dist/_routes.json +0 -30
- package/website/dist/_worker.js/_@astrojs-ssr-adapter.mjs +0 -1033
- package/website/dist/_worker.js/_astro-internal_middleware.mjs +0 -40
- package/website/dist/_worker.js/chunks/abap_BTmsHiP5.mjs +0 -1
- package/website/dist/_worker.js/chunks/actionscript-3_DmBelb1E.mjs +0 -1
- package/website/dist/_worker.js/chunks/ada_8-E0ahCN.mjs +0 -1
- package/website/dist/_worker.js/chunks/andromeeda_XI-CXx50.mjs +0 -1
- package/website/dist/_worker.js/chunks/angular-html_DKGh3gGH.mjs +0 -1
- package/website/dist/_worker.js/chunks/angular-ts_-qZGsJoA.mjs +0 -1
- package/website/dist/_worker.js/chunks/apache_ijTUt0Ee.mjs +0 -1
- package/website/dist/_worker.js/chunks/apex_agu1c6Sh.mjs +0 -1
- package/website/dist/_worker.js/chunks/apl_Bj2f7Art.mjs +0 -1
- package/website/dist/_worker.js/chunks/applescript_B_vXrOh3.mjs +0 -1
- package/website/dist/_worker.js/chunks/ara_DCEQ2rnh.mjs +0 -1
- package/website/dist/_worker.js/chunks/asciidoc_CGN_EkYS.mjs +0 -1
- package/website/dist/_worker.js/chunks/asm_BBWZgnDp.mjs +0 -1
- package/website/dist/_worker.js/chunks/astro/assets-service_j52rQLzU.mjs +0 -721
- package/website/dist/_worker.js/chunks/astro/server_Y5_QHO8v.mjs +0 -2401
- package/website/dist/_worker.js/chunks/astro-designed-error-pages_BNTLO-TA.mjs +0 -542
- package/website/dist/_worker.js/chunks/astro_Dr_hht3h.mjs +0 -1
- package/website/dist/_worker.js/chunks/aurora-x_9GHG8nSq.mjs +0 -1
- package/website/dist/_worker.js/chunks/awk_DHRvhXot.mjs +0 -1
- package/website/dist/_worker.js/chunks/ayu-dark_CcvqmEHE.mjs +0 -1
- package/website/dist/_worker.js/chunks/ballerina_C7SdeSZb.mjs +0 -1
- package/website/dist/_worker.js/chunks/bat_Dv4A3u45.mjs +0 -1
- package/website/dist/_worker.js/chunks/beancount_BfPf9Luv.mjs +0 -1
- package/website/dist/_worker.js/chunks/berry_B8rfM3lL.mjs +0 -1
- package/website/dist/_worker.js/chunks/bibtex_TcjYgtJM.mjs +0 -1
- package/website/dist/_worker.js/chunks/bicep_CrlFWCdN.mjs +0 -1
- package/website/dist/_worker.js/chunks/blade_lanKVYID.mjs +0 -1
- package/website/dist/_worker.js/chunks/bsl_BhppzXMB.mjs +0 -1
- package/website/dist/_worker.js/chunks/c_6FBALJTK.mjs +0 -1
- package/website/dist/_worker.js/chunks/cadence_2txU9LVE.mjs +0 -1
- package/website/dist/_worker.js/chunks/cairo_BkrFAIlP.mjs +0 -1
- package/website/dist/_worker.js/chunks/catppuccin-frappe_CkEqIYhU.mjs +0 -1
- package/website/dist/_worker.js/chunks/catppuccin-latte_DG4Gx_-v.mjs +0 -1
- package/website/dist/_worker.js/chunks/catppuccin-macchiato_Cwi3vCXf.mjs +0 -1
- package/website/dist/_worker.js/chunks/catppuccin-mocha_L9_OPlFX.mjs +0 -1
- package/website/dist/_worker.js/chunks/clarity_BEAe4Ulu.mjs +0 -1
- package/website/dist/_worker.js/chunks/clojure_VnUX6p2g.mjs +0 -1
- package/website/dist/_worker.js/chunks/cmake_0-SGkZEj.mjs +0 -1
- package/website/dist/_worker.js/chunks/cobol_92M_KGaE.mjs +0 -1
- package/website/dist/_worker.js/chunks/codeowners_CzMwskBv.mjs +0 -1
- package/website/dist/_worker.js/chunks/codeql_DWJZNHv1.mjs +0 -1
- package/website/dist/_worker.js/chunks/coffee_CQjKU2fh.mjs +0 -1
- package/website/dist/_worker.js/chunks/common-lisp_BBLWDpS5.mjs +0 -1
- package/website/dist/_worker.js/chunks/coq_hedRFV3D.mjs +0 -1
- package/website/dist/_worker.js/chunks/cpp_DlS1i6Zs.mjs +0 -1
- package/website/dist/_worker.js/chunks/crystal_D6n65fKV.mjs +0 -1
- package/website/dist/_worker.js/chunks/csharp_C6FCVFzc.mjs +0 -1
- package/website/dist/_worker.js/chunks/css_C5uJEgmJ.mjs +0 -1
- package/website/dist/_worker.js/chunks/csv_CtMYuuJl.mjs +0 -1
- package/website/dist/_worker.js/chunks/cue_BsPexqx6.mjs +0 -1
- package/website/dist/_worker.js/chunks/cypher_apzf6OBi.mjs +0 -1
- package/website/dist/_worker.js/chunks/d_DcvIRcgm.mjs +0 -1
- package/website/dist/_worker.js/chunks/dark-plus_C01ONtzj.mjs +0 -1
- package/website/dist/_worker.js/chunks/dart_WkzM5WrV.mjs +0 -1
- package/website/dist/_worker.js/chunks/dax_DjXAO5V4.mjs +0 -1
- package/website/dist/_worker.js/chunks/desktop_C92LCxdc.mjs +0 -1
- package/website/dist/_worker.js/chunks/diff_CVwM_9XJ.mjs +0 -1
- package/website/dist/_worker.js/chunks/docker_DPzgJf6Z.mjs +0 -1
- package/website/dist/_worker.js/chunks/dotenv_D_vgANvA.mjs +0 -1
- package/website/dist/_worker.js/chunks/dracula-soft_CLnUBwFm.mjs +0 -1
- package/website/dist/_worker.js/chunks/dracula_lBVpb6Lb.mjs +0 -1
- package/website/dist/_worker.js/chunks/dream-maker_DTLbzd_J.mjs +0 -1
- package/website/dist/_worker.js/chunks/edge_i54JYm3_.mjs +0 -1
- package/website/dist/_worker.js/chunks/elixir_BJCIjTu4.mjs +0 -1
- package/website/dist/_worker.js/chunks/elm_BbXD39-_.mjs +0 -1
- package/website/dist/_worker.js/chunks/emacs-lisp_pxa5cXaN.mjs +0 -1
- package/website/dist/_worker.js/chunks/erb_Ccjijeee.mjs +0 -1
- package/website/dist/_worker.js/chunks/erlang_B2VM_hi7.mjs +0 -1
- package/website/dist/_worker.js/chunks/everforest-dark_BxvIPBim.mjs +0 -1
- package/website/dist/_worker.js/chunks/everforest-light_B7VoyaJM.mjs +0 -1
- package/website/dist/_worker.js/chunks/fennel_D-uo7X6c.mjs +0 -1
- package/website/dist/_worker.js/chunks/fish_BjePoK3m.mjs +0 -1
- package/website/dist/_worker.js/chunks/fluent_C8fgkzLX.mjs +0 -1
- package/website/dist/_worker.js/chunks/fortran-fixed-form_D1pu5zrc.mjs +0 -1
- package/website/dist/_worker.js/chunks/fortran-free-form_CSGOhJD6.mjs +0 -1
- package/website/dist/_worker.js/chunks/fsharp_B0xy-A4Y.mjs +0 -1
- package/website/dist/_worker.js/chunks/gdresource_CWppjlHq.mjs +0 -1
- package/website/dist/_worker.js/chunks/gdscript_eQCHchcS.mjs +0 -1
- package/website/dist/_worker.js/chunks/gdshader_C4kxepX7.mjs +0 -1
- package/website/dist/_worker.js/chunks/genie_ACtQLcDW.mjs +0 -1
- package/website/dist/_worker.js/chunks/gherkin_BFp2uKUd.mjs +0 -1
- package/website/dist/_worker.js/chunks/git-commit_CLg9ZwMV.mjs +0 -1
- package/website/dist/_worker.js/chunks/git-rebase_DG8A80Nt.mjs +0 -1
- package/website/dist/_worker.js/chunks/github-dark-default_BI0EP2Kv.mjs +0 -1
- package/website/dist/_worker.js/chunks/github-dark-dimmed_a_NIC0Xb.mjs +0 -1
- package/website/dist/_worker.js/chunks/github-dark-high-contrast_jZGqT7hk.mjs +0 -1
- package/website/dist/_worker.js/chunks/github-dark_CHCDNd2O.mjs +0 -1
- package/website/dist/_worker.js/chunks/github-light-default_DRbOW5RG.mjs +0 -1
- package/website/dist/_worker.js/chunks/github-light-high-contrast_tn_kWutM.mjs +0 -1
- package/website/dist/_worker.js/chunks/github-light_D9brYzot.mjs +0 -1
- package/website/dist/_worker.js/chunks/gleam_Dmhu1oxW.mjs +0 -1
- package/website/dist/_worker.js/chunks/glimmer-js_BfZbXy8A.mjs +0 -1
- package/website/dist/_worker.js/chunks/glimmer-ts_B9QVICrD.mjs +0 -1
- package/website/dist/_worker.js/chunks/glsl_DD2PPwOs.mjs +0 -1
- package/website/dist/_worker.js/chunks/gnuplot_D2OYChUX.mjs +0 -1
- package/website/dist/_worker.js/chunks/go_DYGFTe3h.mjs +0 -1
- package/website/dist/_worker.js/chunks/graphql_B7XsT3nH.mjs +0 -1
- package/website/dist/_worker.js/chunks/groovy_BO12Uwkl.mjs +0 -1
- package/website/dist/_worker.js/chunks/hack_CB2_ztCP.mjs +0 -1
- package/website/dist/_worker.js/chunks/haml_CyfDcDD3.mjs +0 -1
- package/website/dist/_worker.js/chunks/handlebars_CfpxpWm2.mjs +0 -1
- package/website/dist/_worker.js/chunks/haskell_jUeC5uN5.mjs +0 -1
- package/website/dist/_worker.js/chunks/haxe_B6GxP1WB.mjs +0 -1
- package/website/dist/_worker.js/chunks/hcl_DwoHV2oh.mjs +0 -1
- package/website/dist/_worker.js/chunks/hjson_DV7cJRk4.mjs +0 -1
- package/website/dist/_worker.js/chunks/hlsl_BlFCscPI.mjs +0 -1
- package/website/dist/_worker.js/chunks/houston_COBFG1Mx.mjs +0 -1
- package/website/dist/_worker.js/chunks/html-derivative_C9pJ337h.mjs +0 -1
- package/website/dist/_worker.js/chunks/html_D1OkrZS5.mjs +0 -1
- package/website/dist/_worker.js/chunks/http_DIGXRqvJ.mjs +0 -1
- package/website/dist/_worker.js/chunks/hxml_DEwh9i-c.mjs +0 -1
- package/website/dist/_worker.js/chunks/hy_DDoIgW1K.mjs +0 -1
- package/website/dist/_worker.js/chunks/imba_B00zbHo4.mjs +0 -1
- package/website/dist/_worker.js/chunks/index_C1UTDwYg.mjs +0 -1861
- package/website/dist/_worker.js/chunks/ini_D7XQA_p8.mjs +0 -1
- package/website/dist/_worker.js/chunks/java_B9wdFd8K.mjs +0 -1
- package/website/dist/_worker.js/chunks/javascript_CLsPGOON.mjs +0 -1
- package/website/dist/_worker.js/chunks/jinja_jarBCAN1.mjs +0 -1
- package/website/dist/_worker.js/chunks/jison_oGg3J708.mjs +0 -1
- package/website/dist/_worker.js/chunks/json5_DlZ1Kyaa.mjs +0 -1
- package/website/dist/_worker.js/chunks/json_DaYk_FMp.mjs +0 -1
- package/website/dist/_worker.js/chunks/jsonc_DlwgfSDs.mjs +0 -1
- package/website/dist/_worker.js/chunks/jsonl_BbCCVaZF.mjs +0 -1
- package/website/dist/_worker.js/chunks/jsonnet_Dt-G75xe.mjs +0 -1
- package/website/dist/_worker.js/chunks/jssm_BtKFTj2A.mjs +0 -1
- package/website/dist/_worker.js/chunks/jsx_DDx_xAZ8.mjs +0 -1
- package/website/dist/_worker.js/chunks/julia_CK0lv68l.mjs +0 -1
- package/website/dist/_worker.js/chunks/kanagawa-dragon_BldAK3Oo.mjs +0 -1
- package/website/dist/_worker.js/chunks/kanagawa-lotus_DVM8FX9_.mjs +0 -1
- package/website/dist/_worker.js/chunks/kanagawa-wave_Dpih0AKP.mjs +0 -1
- package/website/dist/_worker.js/chunks/kotlin_kWneB9V_.mjs +0 -1
- package/website/dist/_worker.js/chunks/kusto_BKVATd95.mjs +0 -1
- package/website/dist/_worker.js/chunks/laserwave_BqatxsVl.mjs +0 -1
- package/website/dist/_worker.js/chunks/latex_LVDcGBbc.mjs +0 -1
- package/website/dist/_worker.js/chunks/lean_W7qo-5M2.mjs +0 -1
- package/website/dist/_worker.js/chunks/less_DFNwJnBH.mjs +0 -1
- package/website/dist/_worker.js/chunks/light-plus_Dp0AoWsO.mjs +0 -1
- package/website/dist/_worker.js/chunks/liquid_D24qs0pc.mjs +0 -1
- package/website/dist/_worker.js/chunks/log_IPWMXriF.mjs +0 -1
- package/website/dist/_worker.js/chunks/logo_C6KaatrQ.mjs +0 -1
- package/website/dist/_worker.js/chunks/lua_CwnEf-T7.mjs +0 -1
- package/website/dist/_worker.js/chunks/luau_Br3-CXjS.mjs +0 -1
- package/website/dist/_worker.js/chunks/make_UBNG-kOo.mjs +0 -1
- package/website/dist/_worker.js/chunks/markdown_C7mhJFCm.mjs +0 -1
- package/website/dist/_worker.js/chunks/marko_4tchUvI7.mjs +0 -1
- package/website/dist/_worker.js/chunks/material-theme-darker_SKtaNEPn.mjs +0 -1
- package/website/dist/_worker.js/chunks/material-theme-lighter_zOX_DZCH.mjs +0 -1
- package/website/dist/_worker.js/chunks/material-theme-ocean_BN9WbhdC.mjs +0 -1
- package/website/dist/_worker.js/chunks/material-theme-palenight_DT_covjH.mjs +0 -1
- package/website/dist/_worker.js/chunks/material-theme_6RpeM3kc.mjs +0 -1
- package/website/dist/_worker.js/chunks/matlab_DCOXsPKR.mjs +0 -1
- package/website/dist/_worker.js/chunks/mdc_B9gb2UFP.mjs +0 -1
- package/website/dist/_worker.js/chunks/mdx_DGU7Nu9u.mjs +0 -1
- package/website/dist/_worker.js/chunks/mermaid_B69URzsZ.mjs +0 -1
- package/website/dist/_worker.js/chunks/min-dark_BgxifOMI.mjs +0 -1
- package/website/dist/_worker.js/chunks/min-light_BrPjXxUp.mjs +0 -1
- package/website/dist/_worker.js/chunks/mipsasm_9U-4_t7k.mjs +0 -1
- package/website/dist/_worker.js/chunks/mojo_B0wt7ug3.mjs +0 -1
- package/website/dist/_worker.js/chunks/monokai_B6Pxpoyi.mjs +0 -1
- package/website/dist/_worker.js/chunks/move_1eid4CyR.mjs +0 -1
- package/website/dist/_worker.js/chunks/narrat_Ds6-p5JZ.mjs +0 -1
- package/website/dist/_worker.js/chunks/nextflow_v2N1Qlqa.mjs +0 -1
- package/website/dist/_worker.js/chunks/nginx_Bp9Ab2NH.mjs +0 -1
- package/website/dist/_worker.js/chunks/night-owl_CdwOw_sc.mjs +0 -1
- package/website/dist/_worker.js/chunks/nim_BXGDUe53.mjs +0 -1
- package/website/dist/_worker.js/chunks/nix_CUig1nJH.mjs +0 -1
- package/website/dist/_worker.js/chunks/noop-middleware_DlWGj5t5.mjs +0 -10
- package/website/dist/_worker.js/chunks/nord_SPoG1iae.mjs +0 -1
- package/website/dist/_worker.js/chunks/nushell_DJw1Lca8.mjs +0 -1
- package/website/dist/_worker.js/chunks/objective-c_Bktzl_CO.mjs +0 -1
- package/website/dist/_worker.js/chunks/objective-cpp_CP4DWdDp.mjs +0 -1
- package/website/dist/_worker.js/chunks/ocaml_CeEAs7bZ.mjs +0 -1
- package/website/dist/_worker.js/chunks/one-dark-pro_-hIwCNMi.mjs +0 -1
- package/website/dist/_worker.js/chunks/one-light_DSmYvJ05.mjs +0 -1
- package/website/dist/_worker.js/chunks/pascal_C-S_Ms_o.mjs +0 -1
- package/website/dist/_worker.js/chunks/perl_CKamvo15.mjs +0 -1
- package/website/dist/_worker.js/chunks/php_BlmcX_F3.mjs +0 -1
- package/website/dist/_worker.js/chunks/plastic_Ryt8tVoA.mjs +0 -1
- package/website/dist/_worker.js/chunks/plsql_Cb3v7cBj.mjs +0 -1
- package/website/dist/_worker.js/chunks/po_DZbdNRlo.mjs +0 -1
- package/website/dist/_worker.js/chunks/poimandres_bYmE3_5d.mjs +0 -1
- package/website/dist/_worker.js/chunks/polar_pJkMGwoW.mjs +0 -1
- package/website/dist/_worker.js/chunks/postcss_BAXSOKgk.mjs +0 -1
- package/website/dist/_worker.js/chunks/powerquery_oITMGN4x.mjs +0 -1
- package/website/dist/_worker.js/chunks/powershell_6306-xIF.mjs +0 -1
- package/website/dist/_worker.js/chunks/prisma_DSDxnZGz.mjs +0 -1
- package/website/dist/_worker.js/chunks/prolog_CxG7tjZR.mjs +0 -1
- package/website/dist/_worker.js/chunks/proto_CS9ByXm1.mjs +0 -1
- package/website/dist/_worker.js/chunks/pug_BMtLJo6U.mjs +0 -1
- package/website/dist/_worker.js/chunks/puppet_BfeeSzee.mjs +0 -1
- package/website/dist/_worker.js/chunks/purescript_BFfueNaH.mjs +0 -1
- package/website/dist/_worker.js/chunks/python_Cc4Faapv.mjs +0 -1
- package/website/dist/_worker.js/chunks/qml_C1CTJTK8.mjs +0 -1
- package/website/dist/_worker.js/chunks/qmldir_nG1KaqKR.mjs +0 -1
- package/website/dist/_worker.js/chunks/qss_Cncxk263.mjs +0 -1
- package/website/dist/_worker.js/chunks/r_ChR54Ihi.mjs +0 -1
- package/website/dist/_worker.js/chunks/racket_BDrhptDs.mjs +0 -1
- package/website/dist/_worker.js/chunks/raku_07OUHa0P.mjs +0 -1
- package/website/dist/_worker.js/chunks/razor_DIP3INLa.mjs +0 -1
- package/website/dist/_worker.js/chunks/red_DOPXfj-6.mjs +0 -1
- package/website/dist/_worker.js/chunks/reg_B64SwEDj.mjs +0 -1
- package/website/dist/_worker.js/chunks/regexp_ButFGoB5.mjs +0 -1
- package/website/dist/_worker.js/chunks/rel_BWJAWqZD.mjs +0 -1
- package/website/dist/_worker.js/chunks/riscv_79gXlbsF.mjs +0 -1
- package/website/dist/_worker.js/chunks/rose-pine-dawn_DHIjVGd3.mjs +0 -1
- package/website/dist/_worker.js/chunks/rose-pine-moon_t86aEbs0.mjs +0 -1
- package/website/dist/_worker.js/chunks/rose-pine_BHgrcDCs.mjs +0 -1
- package/website/dist/_worker.js/chunks/rst_D3F4Fcpj.mjs +0 -1
- package/website/dist/_worker.js/chunks/ruby_Cs7vM9iv.mjs +0 -1
- package/website/dist/_worker.js/chunks/rust_DpyRVatH.mjs +0 -1
- package/website/dist/_worker.js/chunks/sas_DW45xZXN.mjs +0 -1
- package/website/dist/_worker.js/chunks/sass_C6SiMwN_.mjs +0 -1
- package/website/dist/_worker.js/chunks/scala_DlZOjNZk.mjs +0 -1
- package/website/dist/_worker.js/chunks/scheme_D2ezSJXu.mjs +0 -1
- package/website/dist/_worker.js/chunks/scss_DG5Spjqu.mjs +0 -1
- package/website/dist/_worker.js/chunks/sdbl_ZCYaj4VN.mjs +0 -1
- package/website/dist/_worker.js/chunks/shaderlab_CAcRkg1_.mjs +0 -1
- package/website/dist/_worker.js/chunks/shellscript_BWwhkDVh.mjs +0 -1
- package/website/dist/_worker.js/chunks/shellsession_BfEA3juK.mjs +0 -1
- package/website/dist/_worker.js/chunks/slack-dark_CL3lSpCc.mjs +0 -1
- package/website/dist/_worker.js/chunks/slack-ochin_DdZKOQVh.mjs +0 -1
- package/website/dist/_worker.js/chunks/smalltalk_DgilzSui.mjs +0 -1
- package/website/dist/_worker.js/chunks/snazzy-light_eJU08Pz_.mjs +0 -1
- package/website/dist/_worker.js/chunks/solarized-dark_Dg_YQywx.mjs +0 -1
- package/website/dist/_worker.js/chunks/solarized-light_BnIsrA6p.mjs +0 -1
- package/website/dist/_worker.js/chunks/solidity_DkseH8pQ.mjs +0 -1
- package/website/dist/_worker.js/chunks/soy_DU7bOYoG.mjs +0 -1
- package/website/dist/_worker.js/chunks/sparql_BuI1DBDH.mjs +0 -1
- package/website/dist/_worker.js/chunks/splunk_B8Ha9Pkg.mjs +0 -1
- package/website/dist/_worker.js/chunks/sql_BniHwea5.mjs +0 -1
- package/website/dist/_worker.js/chunks/ssh-config_CkE1GuVe.mjs +0 -1
- package/website/dist/_worker.js/chunks/stata_Dtqpbd_l.mjs +0 -1
- package/website/dist/_worker.js/chunks/stylus_CXTtglzO.mjs +0 -1
- package/website/dist/_worker.js/chunks/svelte_BjWYcUCN.mjs +0 -1
- package/website/dist/_worker.js/chunks/swift_BzHql_rM.mjs +0 -1
- package/website/dist/_worker.js/chunks/synthwave-84_DLRNhxNA.mjs +0 -1
- package/website/dist/_worker.js/chunks/system-verilog_ChyInPph.mjs +0 -1
- package/website/dist/_worker.js/chunks/systemd_Bi9Qa2qD.mjs +0 -1
- package/website/dist/_worker.js/chunks/talonscript_B3sH_Y-V.mjs +0 -1
- package/website/dist/_worker.js/chunks/tasl_BJ5yipRs.mjs +0 -1
- package/website/dist/_worker.js/chunks/tcl_CoJQjNoP.mjs +0 -1
- package/website/dist/_worker.js/chunks/templ_CrU7Ffil.mjs +0 -1
- package/website/dist/_worker.js/chunks/terraform_DT9JSFpC.mjs +0 -1
- package/website/dist/_worker.js/chunks/tex_5PKu2yA0.mjs +0 -1
- package/website/dist/_worker.js/chunks/tokyo-night_Buo8OK7-.mjs +0 -1
- package/website/dist/_worker.js/chunks/toml_CPuXX3oc.mjs +0 -1
- package/website/dist/_worker.js/chunks/ts-tags_D0M_1VSH.mjs +0 -1
- package/website/dist/_worker.js/chunks/tsv_CuivVNot.mjs +0 -1
- package/website/dist/_worker.js/chunks/tsx_MkuGr8MY.mjs +0 -1
- package/website/dist/_worker.js/chunks/turtle_BqgEPK7f.mjs +0 -1
- package/website/dist/_worker.js/chunks/twig_r1G9rpYJ.mjs +0 -1
- package/website/dist/_worker.js/chunks/typescript_Au5buqzM.mjs +0 -1
- package/website/dist/_worker.js/chunks/typespec_47rhBK_z.mjs +0 -1
- package/website/dist/_worker.js/chunks/typst_BAtuQLh-.mjs +0 -1
- package/website/dist/_worker.js/chunks/v_BIvWImHg.mjs +0 -1
- package/website/dist/_worker.js/chunks/vala_DYEacj30.mjs +0 -1
- package/website/dist/_worker.js/chunks/vb_CikQuqGJ.mjs +0 -1
- package/website/dist/_worker.js/chunks/verilog_BQRENwI-.mjs +0 -1
- package/website/dist/_worker.js/chunks/vesper_DA0kvTmj.mjs +0 -1
- package/website/dist/_worker.js/chunks/vhdl_DHscJIyg.mjs +0 -1
- package/website/dist/_worker.js/chunks/viml_F2pvMwvG.mjs +0 -1
- package/website/dist/_worker.js/chunks/vitesse-black_D9tjNzd0.mjs +0 -1
- package/website/dist/_worker.js/chunks/vitesse-dark_Bnm5d0hd.mjs +0 -1
- package/website/dist/_worker.js/chunks/vitesse-light_CHwbyjNR.mjs +0 -1
- package/website/dist/_worker.js/chunks/vue-html_DyYtbbMK.mjs +0 -1
- package/website/dist/_worker.js/chunks/vue_DofN6juy.mjs +0 -1
- package/website/dist/_worker.js/chunks/vyper_CiR0m-OV.mjs +0 -1
- package/website/dist/_worker.js/chunks/wasm_CwIGgRGf.mjs +0 -1
- package/website/dist/_worker.js/chunks/wasm_jKWhg0J0.mjs +0 -1
- package/website/dist/_worker.js/chunks/wenyan_DKvVZKXW.mjs +0 -1
- package/website/dist/_worker.js/chunks/wgsl_BOWZY7yw.mjs +0 -1
- package/website/dist/_worker.js/chunks/wikitext_CXDhhHPy.mjs +0 -1
- package/website/dist/_worker.js/chunks/wolfram_ChkmGnW0.mjs +0 -1
- package/website/dist/_worker.js/chunks/xml_DXH3hHIu.mjs +0 -1
- package/website/dist/_worker.js/chunks/xsl_DuP2mFjg.mjs +0 -1
- package/website/dist/_worker.js/chunks/yaml_IGiEkTge.mjs +0 -1
- package/website/dist/_worker.js/chunks/zenscript_59iXGyNw.mjs +0 -1
- package/website/dist/_worker.js/chunks/zig_DKzb0zdT.mjs +0 -1
- package/website/dist/_worker.js/index.js +0 -53
- package/website/dist/_worker.js/manifest_CT_D-YDe.mjs +0 -98
- package/website/dist/_worker.js/pages/_image.astro.mjs +0 -24
- package/website/dist/_worker.js/pages/agents.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/animation.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/api/raw-markdown/_---path_.astro.mjs +0 -44
- package/website/dist/_worker.js/pages/config.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/fonts.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/getting-started.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/helpers.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/images.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/index.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/llm.txt.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/preview.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/sdk.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/sitemap.xml.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/styling.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/templates.astro.mjs +0 -1
- package/website/dist/_worker.js/pages/video.astro.mjs +0 -1
- package/website/dist/_worker.js/renderers.mjs +0 -57
- package/website/dist/agents/index.html +0 -52
- package/website/dist/animation/index.html +0 -879
- package/website/dist/config/index.html +0 -184
- package/website/dist/fonts/index.html +0 -198
- package/website/dist/getting-started/index.html +0 -107
- package/website/dist/helpers/index.html +0 -164
- package/website/dist/images/index.html +0 -335
- package/website/dist/index.html +0 -140
- package/website/dist/llm.txt +0 -2776
- package/website/dist/preview/index.html +0 -111
- package/website/dist/robots.txt +0 -40
- package/website/dist/sdk/index.html +0 -1076
- package/website/dist/sitemap.xml +0 -76
- package/website/dist/styling/index.html +0 -366
- package/website/dist/templates/index.html +0 -74
- package/website/dist/video/index.html +0 -319
- package/website/package-lock.json +0 -8089
- package/website/package.json +0 -41
- package/website/public/.gitkeep +0 -5
- package/website/public/robots.txt +0 -40
- package/website/templates/og-image.tsx +0 -60
|
@@ -1,1076 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html lang="en" data-astro-cid-mw7aashj> <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><link rel="icon" type="image/svg+xml" href="/favicon.svg"><meta name="generator" content="Astro v4.16.19"><link rel="canonical" href="https://loopwind.dev/sdk/"><!-- Primary Meta Tags --><title></title><meta name="title"><meta name="description" content="CLI-based Image & Video Generator for developers and AI Agents. Generate stunning visuals from React + Tailwind templates."><meta name="keywords" content="loopwind, image generation, video generation, React, Tailwind CSS, Satori, CLI tool, templates, shadcn/ui, AI agents, Cursor, automation, serverless, WASM, Open Graph, social media, marketing automation"><meta name="author" content="loopwind"><!-- Open Graph / Facebook --><meta property="og:type" content="website"><meta property="og:url" content="https://loopwind.dev/sdk/"><meta property="og:title"><meta property="og:description" content="CLI-based Image & Video Generator for developers and AI Agents. Generate stunning visuals from React + Tailwind templates."><meta property="og:image" content="https://loopwind.dev/api/og/sdk"><meta property="og:image:width" content="1200"><meta property="og:image:height" content="630"><meta property="og:image:alt"><meta property="og:site_name" content="loopwind"><meta property="og:locale" content="en_US"><!-- Twitter --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:url" content="https://loopwind.dev/sdk/"><meta name="twitter:title"><meta name="twitter:description" content="CLI-based Image & Video Generator for developers and AI Agents. Generate stunning visuals from React + Tailwind templates."><meta name="twitter:image" content="https://loopwind.dev/api/og/sdk"><meta name="twitter:image:alt"><meta name="twitter:creator" content="@loopwind"><meta name="twitter:site" content="@loopwind"><!-- Theme Color --><meta name="theme-color" content="#0a0a0a"><meta name="theme-color" media="(prefers-color-scheme: dark)" content="#0a0a0a"><meta name="theme-color" media="(prefers-color-scheme: light)" content="#fafafa"><!-- Additional SEO --><meta name="robots" content="index, follow"><meta name="googlebot" content="index, follow"><meta name="language" content="English"><meta name="revisit-after" content="7 days"><meta name="rating" content="general"><!-- Mobile Web App --><meta name="mobile-web-app-capable" content="yes"><meta name="apple-mobile-web-app-capable" content="yes"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><meta name="apple-mobile-web-app-title" content="loopwind"><!-- Structured Data (JSON-LD) --><script type="application/ld+json">{"@context":"https://schema.org","@type":"SoftwareApplication","name":"loopwind","applicationCategory":"DeveloperApplication","operatingSystem":"Cross-platform","description":"CLI-based Image & Video Generator for developers and AI Agents. Generate stunning visuals from React + Tailwind templates.","url":"https://loopwind.dev/","author":{"@type":"Organization","name":"loopwind","url":"https://loopwind.dev/"},"offers":{"@type":"Offer","price":"0","priceCurrency":"USD"},"softwareVersion":"0.11.0","releaseNotes":"https://github.com/loopwind/loopwind/releases","screenshot":"https://loopwind.dev/api/og/sdk","featureList":["Image generation from React templates","Video generation with animations","Tailwind CSS support","shadcn/ui design system","CLI-based workflow","Serverless rendering","TypeScript support","AI Agent friendly"]}</script><script type="application/ld+json">{"@context":"https://schema.org","@type":"Organization","name":"loopwind","url":"https://loopwind.dev/","logo":"https://loopwind.dev/favicon.svg","sameAs":["https://github.com/loopwind/loopwind","https://www.npmjs.com/package/loopwind"]}</script><script type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https://loopwind.dev/"},{"@type":"ListItem","position":2,"name":"Sdk","item":"https://loopwind.dev/sdk"}]}</script><link rel="stylesheet" href="/_astro/agents.Yx-L_igG.css"><script type="module">const p=document.getElementById("mobile-menu-button"),l=document.getElementById("mobile-menu"),g=document.querySelectorAll(".mobile-menu-link");p?.addEventListener("click",()=>{l?.classList.toggle("hidden")});l?.addEventListener("click",o=>{o.target===l&&l.classList.add("hidden")});g.forEach(o=>{o.addEventListener("click",()=>{l?.classList.add("hidden")})});function m(){const o=document.getElementById("toc-nav");if(!o){console.log("TOC: No toc-nav element found");return}const n=document.querySelector("article");if(!n){console.log("TOC: No article element found");return}const c=n.querySelectorAll("h2, h3");if(c.length===0){console.log("TOC: No headings found");return}console.log(`TOC: Found ${c.length} headings`);const a=document.createElement("ul");a.className="space-y-0 text-sm border-l border-border/50",c.forEach(e=>{const t=e.tagName==="H2"?2:3,r=e.id||e.textContent?.toLowerCase().replace(/[^\w]+/g,"-");!e.id&&r&&(e.id=r);const s=document.createElement("li"),d=document.createElement("a");d.href=`#${r}`,d.textContent=e.textContent,d.className=`toc-link block py-1 px-3 -ml-px border-l-2 border-transparent transition-all no-underline ${t===3?"pl-6 text-xs text-muted-foreground/70":"text-sm text-muted-foreground"} hover:text-foreground hover:border-muted-foreground/50`,s.appendChild(d),a.appendChild(s)}),o.appendChild(a);const i=new IntersectionObserver(e=>{e.forEach(t=>{const r=t.target.id,s=o.querySelector(`a[href="#${r}"]`);t.isIntersecting&&(document.querySelectorAll(".toc-link").forEach(d=>{d.classList.remove("text-foreground","border-accent","font-medium")}),s?.classList.add("text-foreground","border-accent","font-medium"))})},{rootMargin:"-100px 0px -66%",threshold:0});c.forEach(e=>{i.observe(e)})}document.addEventListener("DOMContentLoaded",m);document.addEventListener("astro:page-load",m);function u(){const o=document.getElementById("copy-to-llm-btn"),n=document.getElementById("copy-btn-text");if(!o||!n){console.log("Copy to LLM: Button not found on this page");return}console.log("Copy to LLM: Initialized"),o.addEventListener("click",async()=>{const c=window.location.pathname,a=c.replace(/^\//,"").replace(/\/$/,""),e=`/api/raw-markdown/${a===""?"index":a}`;console.log("Copy to LLM clicked: pathname=",c,"apiUrl=",e);try{n.textContent="Copying...";const t=await fetch(e);if(console.log("Response status:",t.status),!t.ok)throw new Error(`HTTP error! status: ${t.status}`);const r=await t.text();console.log("Got markdown, length:",r.length),await navigator.clipboard.writeText(r),n.textContent="Copied!",setTimeout(()=>{n.textContent="Copy to LLM"},2e3)}catch(t){console.error("Copy failed:",t),n.textContent="Failed",setTimeout(()=>{n.textContent="Copy to LLM"},2e3)}})}document.addEventListener("DOMContentLoaded",u);document.addEventListener("astro:page-load",u);
|
|
2
|
-
</script></head> <body class="antialiased" data-astro-cid-mw7aashj> <div class="min-h-screen" data-astro-cid-mw7aashj> <!-- Mobile Header --> <header class="mobile-header fixed top-0 left-0 right-0 h-16 bg-card border-b border-border z-50 md:hidden" data-astro-cid-mw7aashj> <div class="flex items-center justify-between h-full px-4" data-astro-cid-mw7aashj> <a href="/" class="no-underline"> <h1 class="text-xl flex items-center gap-2 bg-linear-to-r from-brand-from to-brand-to bg-clip-text text-transparent"> <span class="text-2xl">➰</span> <span>loopwind</span> </h1> </a> <button id="mobile-menu-button" class="p-2 text-foreground hover:bg-accent rounded-md transition-colors" aria-label="Toggle menu" data-astro-cid-mw7aashj> <svg class="w-6 h-6" fill="none" stroke="currentColor" viewBox="0 0 24 24" data-astro-cid-mw7aashj> <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 6h16M4 12h16M4 18h16" data-astro-cid-mw7aashj></path> </svg> </button> </div> </header> <!-- Mobile Menu Overlay --> <div id="mobile-menu" class="mobile-menu fixed inset-0 bg-background/80 backdrop-blur-sm z-40 md:hidden hidden" data-astro-cid-mw7aashj> <div class="fixed top-0 left-0 h-screen w-64 bg-card border-r border-border overflow-y-auto" data-astro-cid-mw7aashj> <div class="p-6 pt-20" data-astro-cid-mw7aashj> <nav data-astro-cid-mw7aashj> <ul class="space-y-1" data-astro-cid-mw7aashj> <li data-astro-cid-mw7aashj> <a href="/" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Home </a> </li><li data-astro-cid-mw7aashj> <a href="/getting-started" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Getting Started </a> </li><li data-astro-cid-mw7aashj> <a href="/templates" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Templates </a> </li><li data-astro-cid-mw7aashj> <a href="/images" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Images </a> </li><li data-astro-cid-mw7aashj> <a href="/video" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Video </a> </li><li data-astro-cid-mw7aashj> <a href="/preview" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Preview </a> </li><li data-astro-cid-mw7aashj> <a href="/animation" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Animation </a> </li><li data-astro-cid-mw7aashj> <a href="/helpers" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Helpers </a> </li><li data-astro-cid-mw7aashj> <a href="/styling" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Styling </a> </li><li data-astro-cid-mw7aashj> <a href="/fonts" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Fonts </a> </li><li data-astro-cid-mw7aashj> <a href="/config" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> loopwind.json </a> </li><li data-astro-cid-mw7aashj> <a href="/sdk" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> SDK </a> </li><li data-astro-cid-mw7aashj> <a href="/agents" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Use with AI Agents </a> </li><li data-astro-cid-mw7aashj> <a href="/llm.txt" class="mobile-menu-link block px-3 py-2 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> llm.txt ⇱ </a> </li> </ul> </nav> </div> </div> </div> <!-- Desktop Sidebar --> <aside class="desktop-sidebar fixed top-0 left-0 h-screen w-64 border-r border-border bg-card overflow-y-auto z-10" data-astro-cid-mw7aashj> <div class="p-6" data-astro-cid-mw7aashj> <div class="block mb-3" data-astro-cid-mw7aashj> <a href="/" class="no-underline"> <h1 class="text-3xl flex items-center gap-2 bg-linear-to-r from-brand-from to-brand-to bg-clip-text text-transparent"> <span class="text-4xl">➰</span> <span>loopwind</span> </h1> </a> </div> <nav data-astro-cid-mw7aashj> <ul class="space-y-0" data-astro-cid-mw7aashj> <li data-astro-cid-mw7aashj> <a href="/" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Home </a> </li><li data-astro-cid-mw7aashj> <a href="/getting-started" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Getting Started </a> </li><li data-astro-cid-mw7aashj> <a href="/templates" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Templates </a> </li><li data-astro-cid-mw7aashj> <a href="/images" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Images </a> </li><li data-astro-cid-mw7aashj> <a href="/video" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Video </a> </li><li data-astro-cid-mw7aashj> <a href="/preview" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Preview </a> </li><li data-astro-cid-mw7aashj> <a href="/animation" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Animation </a> </li><li data-astro-cid-mw7aashj> <a href="/helpers" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Helpers </a> </li><li data-astro-cid-mw7aashj> <a href="/styling" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Styling </a> </li><li data-astro-cid-mw7aashj> <a href="/fonts" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Fonts </a> </li><li data-astro-cid-mw7aashj> <a href="/config" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> loopwind.json </a> </li><li data-astro-cid-mw7aashj> <a href="/sdk" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> SDK </a> </li><li data-astro-cid-mw7aashj> <a href="/agents" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> Use with AI Agents </a> </li><li data-astro-cid-mw7aashj> <a href="/llm.txt" class="block px-3 py-1.5 rounded-md text-sm transition-colors no-underline text-muted-foreground hover:text-foreground hover:bg-accent/50" data-astro-cid-mw7aashj> llm.txt ⇱ </a> </li> </ul> </nav> </div> </aside> <!-- Main content --> <main class="ml-64 mr-64" data-astro-cid-mw7aashj> <div class="p-12" data-astro-cid-mw7aashj> <button id="copy-to-llm-btn" class="mb-6 px-4 py-2 bg-accent hover:bg-accent/80 text-accent-foreground rounded-md text-sm font-medium transition-colors flex items-center gap-2" aria-label="Copy raw markdown to clipboard" data-astro-cid-mw7aashj> <svg class="w-4 h-4" fill="none" stroke="currentColor" viewBox="0 0 24 24" data-astro-cid-mw7aashj> <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z" data-astro-cid-mw7aashj></path> </svg> <span id="copy-btn-text" data-astro-cid-mw7aashj>Copy to LLM</span> </button> <article class="prose prose-invert max-w-4xl" data-astro-cid-mw7aashj> <h1 id="sdk">SDK</h1>
|
|
3
|
-
<p>Use <strong>loopwind</strong> programmatically in your Next.js API routes, serverless functions, or Node.js applications. Perfect for building image/video generation APIs!</p>
|
|
4
|
-
<h2 id="installation">Installation</h2>
|
|
5
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#B392F0">npm</span><span style="color:#9ECBFF"> install</span><span style="color:#9ECBFF"> loopwind</span></span>
|
|
6
|
-
<span class="line"></span></code></pre>
|
|
7
|
-
<h2 id="quick-start">Quick Start</h2>
|
|
8
|
-
<p>Create a template file in <code>_loopwind/templates/</code> or <code>templates/</code>:</p>
|
|
9
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="tsx"><code><span class="line"><span style="color:#6A737D">// _loopwind/templates/og-image/template.tsx</span></span>
|
|
10
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> const</span><span style="color:#79B8FF"> meta</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
11
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'og-image'</span><span style="color:#E1E4E8">,</span></span>
|
|
12
|
-
<span class="line"><span style="color:#E1E4E8"> description: </span><span style="color:#9ECBFF">'OpenGraph image'</span><span style="color:#E1E4E8">,</span></span>
|
|
13
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'image'</span><span style="color:#F97583"> as</span><span style="color:#F97583"> const</span><span style="color:#E1E4E8">,</span></span>
|
|
14
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
15
|
-
<span class="line"><span style="color:#E1E4E8"> props: {</span></span>
|
|
16
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'string'</span><span style="color:#E1E4E8">,</span></span>
|
|
17
|
-
<span class="line"><span style="color:#E1E4E8"> description: </span><span style="color:#9ECBFF">'string?'</span><span style="color:#E1E4E8">,</span></span>
|
|
18
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
19
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
20
|
-
<span class="line"></span>
|
|
21
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> OgImage</span><span style="color:#E1E4E8">({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">description</span><span style="color:#E1E4E8"> }) {</span></span>
|
|
22
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> (</span></span>
|
|
23
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex flex-col w-full h-full bg-gradient-to-br from-blue-600 to-purple-700 p-12'</span><span style="color:#E1E4E8">)}></span></span>
|
|
24
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">h1</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-6xl font-bold text-white'</span><span style="color:#E1E4E8">)}>{title}</</span><span style="color:#85E89D">h1</span><span style="color:#E1E4E8">></span></span>
|
|
25
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">p</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-2xl text-white/80'</span><span style="color:#E1E4E8">)}>{description}</</span><span style="color:#85E89D">p</span><span style="color:#E1E4E8">></span></span>
|
|
26
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
27
|
-
<span class="line"><span style="color:#E1E4E8"> );</span></span>
|
|
28
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
29
|
-
<span class="line"></span></code></pre>
|
|
30
|
-
<p>Use it in your API route:</p>
|
|
31
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplateFromFile, renderImage } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
32
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#79B8FF"> *</span><span style="color:#F97583"> as</span><span style="color:#E1E4E8"> ogTemplate </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> './_loopwind/templates/og-image/template'</span><span style="color:#E1E4E8">;</span></span>
|
|
33
|
-
<span class="line"></span>
|
|
34
|
-
<span class="line"><span style="color:#6A737D">// Load template from file</span></span>
|
|
35
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplateFromFile</span><span style="color:#E1E4E8">(ogTemplate, {</span></span>
|
|
36
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
37
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
38
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#3b82f6'</span><span style="color:#E1E4E8">,</span></span>
|
|
39
|
-
<span class="line"><span style="color:#E1E4E8"> background: </span><span style="color:#9ECBFF">'#ffffff'</span><span style="color:#E1E4E8">,</span></span>
|
|
40
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
41
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
42
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
43
|
-
<span class="line"></span>
|
|
44
|
-
<span class="line"><span style="color:#6A737D">// Render to buffer</span></span>
|
|
45
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> png</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template, {</span></span>
|
|
46
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'Hello World'</span><span style="color:#E1E4E8">,</span></span>
|
|
47
|
-
<span class="line"><span style="color:#E1E4E8"> description: </span><span style="color:#9ECBFF">'Generated with loopwind SDK'</span><span style="color:#E1E4E8">,</span></span>
|
|
48
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
49
|
-
<span class="line"></span></code></pre>
|
|
50
|
-
<p><strong>Benefits:</strong></p>
|
|
51
|
-
<ul>
|
|
52
|
-
<li>✅ Reuse templates between CLI and SDK</li>
|
|
53
|
-
<li>✅ Keep templates in separate files (clean organization)</li>
|
|
54
|
-
<li>✅ Standard loopwind format</li>
|
|
55
|
-
<li>✅ Full JSX support with <code><div></code>, <code><h1></code>, etc.</li>
|
|
56
|
-
<li>✅ Works with any bundler (Next.js, Vite, Remix, etc.)</li>
|
|
57
|
-
</ul>
|
|
58
|
-
<h2 id="sdk-vs-cli">SDK vs CLI</h2>
|
|
59
|
-
<p>The SDK is designed to be <strong>completely stateless</strong> and <strong>self-contained</strong> - perfect for serverless environments like Vercel, Netlify, or AWS Lambda.</p>
|
|
60
|
-
<p><strong>Key differences:</strong></p>
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
<table><thead><tr><th>Feature</th><th>CLI (<code>loopwind render</code>)</th><th>SDK (<code>renderImage()</code>)</th></tr></thead><tbody><tr><td><strong>Configuration</strong></td><td>Uses <code>loopwind.json</code> for colors, fonts, paths</td><td>Programmatic <code>StyleConfig</code> passed directly</td></tr><tr><td><strong>Templates</strong></td><td>File-based in <code>_loopwind/templates/</code></td><td>Defined with <code>defineTemplate()</code></td></tr><tr><td><strong>State</strong></td><td>Stateful (project directory)</td><td>Stateless (no filesystem reads)</td></tr><tr><td><strong>Use case</strong></td><td>Local development, project-based</td><td>APIs, serverless, dynamic generation</td></tr></tbody></table>
|
|
92
|
-
<p><strong>Important:</strong> The SDK does <strong>not</strong> read <code>loopwind.json</code> from the filesystem. All configuration (colors, fonts) must be passed programmatically using <code>StyleConfig</code>.</p>
|
|
93
|
-
<h2 id="style-configuration">Style Configuration</h2>
|
|
94
|
-
<p>The SDK accepts configuration through the <code>StyleConfig</code> type, which you can pass in two places:</p>
|
|
95
|
-
<ol>
|
|
96
|
-
<li><strong>In <code>defineTemplate()</code></strong> - For fixed theme per template</li>
|
|
97
|
-
<li><strong>In <code>renderImage()</code>/<code>renderVideo()</code></strong> - For dynamic theming at render time</li>
|
|
98
|
-
</ol>
|
|
99
|
-
<p><strong>Priority:</strong> Options config overrides template config.</p>
|
|
100
|
-
<h3 id="basic-example">Basic Example</h3>
|
|
101
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="tsx"><code><span class="line"><span style="color:#6A737D">// templates/og-image.tsx</span></span>
|
|
102
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> const</span><span style="color:#79B8FF"> meta</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
103
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'og-image'</span><span style="color:#E1E4E8">,</span></span>
|
|
104
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'image'</span><span style="color:#F97583"> as</span><span style="color:#F97583"> const</span><span style="color:#E1E4E8">,</span></span>
|
|
105
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
106
|
-
<span class="line"><span style="color:#E1E4E8"> props: {</span></span>
|
|
107
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'string'</span><span style="color:#E1E4E8">,</span></span>
|
|
108
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
109
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
110
|
-
<span class="line"></span>
|
|
111
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> OgImage</span><span style="color:#E1E4E8">({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) {</span></span>
|
|
112
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> (</span></span>
|
|
113
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full bg-background'</span><span style="color:#E1E4E8">)}></span></span>
|
|
114
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">h1</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-6xl font-bold text-primary'</span><span style="color:#E1E4E8">)}>{title}</</span><span style="color:#85E89D">h1</span><span style="color:#E1E4E8">></span></span>
|
|
115
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
116
|
-
<span class="line"><span style="color:#E1E4E8"> );</span></span>
|
|
117
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
118
|
-
<span class="line"></span></code></pre>
|
|
119
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplateFromFile, renderImage, </span><span style="color:#F97583">type</span><span style="color:#E1E4E8"> StyleConfig } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
120
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#79B8FF"> *</span><span style="color:#F97583"> as</span><span style="color:#E1E4E8"> ogTemplate </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> './templates/og-image'</span><span style="color:#E1E4E8">;</span></span>
|
|
121
|
-
<span class="line"></span>
|
|
122
|
-
<span class="line"><span style="color:#6A737D">// Define your style config</span></span>
|
|
123
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> config</span><span style="color:#F97583">:</span><span style="color:#B392F0"> StyleConfig</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
124
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
125
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#3b82f6'</span><span style="color:#E1E4E8">,</span></span>
|
|
126
|
-
<span class="line"><span style="color:#E1E4E8"> background: </span><span style="color:#9ECBFF">'#ffffff'</span><span style="color:#E1E4E8">,</span></span>
|
|
127
|
-
<span class="line"><span style="color:#E1E4E8"> text: </span><span style="color:#9ECBFF">'#09090b'</span><span style="color:#E1E4E8">,</span></span>
|
|
128
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
129
|
-
<span class="line"><span style="color:#E1E4E8"> fonts: {</span></span>
|
|
130
|
-
<span class="line"><span style="color:#E1E4E8"> sans: [</span><span style="color:#9ECBFF">'Inter'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'system-ui'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'sans-serif'</span><span style="color:#E1E4E8">],</span></span>
|
|
131
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
132
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
133
|
-
<span class="line"></span>
|
|
134
|
-
<span class="line"><span style="color:#6A737D">// Option 1: Pass config when defining template</span></span>
|
|
135
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplateFromFile</span><span style="color:#E1E4E8">(ogTemplate, {</span></span>
|
|
136
|
-
<span class="line"><span style="color:#E1E4E8"> config, </span><span style="color:#6A737D">// Fixed theme for this template</span></span>
|
|
137
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
138
|
-
<span class="line"></span>
|
|
139
|
-
<span class="line"><span style="color:#6A737D">// Option 2: Pass config at render time</span></span>
|
|
140
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> png</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template, { title: </span><span style="color:#9ECBFF">'Hello'</span><span style="color:#E1E4E8"> }, {</span></span>
|
|
141
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
142
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
143
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#8b5cf6'</span><span style="color:#E1E4E8">, </span><span style="color:#6A737D">// Override template config</span></span>
|
|
144
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
145
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
146
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
147
|
-
<span class="line"></span></code></pre>
|
|
148
|
-
<h3 id="dynamic-theming">Dynamic Theming</h3>
|
|
149
|
-
<p>Perfect for multi-tenant apps or user-customizable themes:</p>
|
|
150
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="tsx"><code><span class="line"><span style="color:#6A737D">// templates/branded-og.tsx</span></span>
|
|
151
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> const</span><span style="color:#79B8FF"> meta</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
152
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'branded-og'</span><span style="color:#E1E4E8">,</span></span>
|
|
153
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'image'</span><span style="color:#F97583"> as</span><span style="color:#F97583"> const</span><span style="color:#E1E4E8">,</span></span>
|
|
154
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
155
|
-
<span class="line"><span style="color:#E1E4E8"> props: {</span></span>
|
|
156
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'string'</span><span style="color:#E1E4E8">,</span></span>
|
|
157
|
-
<span class="line"><span style="color:#E1E4E8"> subtitle: </span><span style="color:#9ECBFF">'string'</span><span style="color:#E1E4E8">,</span></span>
|
|
158
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
159
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
160
|
-
<span class="line"></span>
|
|
161
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> BrandedOg</span><span style="color:#E1E4E8">({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">subtitle</span><span style="color:#E1E4E8"> }) {</span></span>
|
|
162
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> (</span></span>
|
|
163
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex flex-col w-full h-full bg-background p-12 justify-between'</span><span style="color:#E1E4E8">)}></span></span>
|
|
164
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center gap-4'</span><span style="color:#E1E4E8">)}></span></span>
|
|
165
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'w-16 h-16 rounded-full bg-brand'</span><span style="color:#E1E4E8">)} /></span></span>
|
|
166
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
167
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
168
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">h1</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-7xl font-bold text-foreground mb-4'</span><span style="color:#E1E4E8">)}>{title}</</span><span style="color:#85E89D">h1</span><span style="color:#E1E4E8">></span></span>
|
|
169
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">p</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-3xl text-muted-foreground'</span><span style="color:#E1E4E8">)}>{subtitle}</</span><span style="color:#85E89D">p</span><span style="color:#E1E4E8">></span></span>
|
|
170
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
171
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
172
|
-
<span class="line"><span style="color:#E1E4E8"> );</span></span>
|
|
173
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
174
|
-
<span class="line"></span></code></pre>
|
|
175
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplateFromFile, renderImage } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
176
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#79B8FF"> *</span><span style="color:#F97583"> as</span><span style="color:#E1E4E8"> brandTemplate </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> './templates/branded-og'</span><span style="color:#E1E4E8">;</span></span>
|
|
177
|
-
<span class="line"></span>
|
|
178
|
-
<span class="line"><span style="color:#6A737D">// Load template</span></span>
|
|
179
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplateFromFile</span><span style="color:#E1E4E8">(brandTemplate);</span></span>
|
|
180
|
-
<span class="line"></span>
|
|
181
|
-
<span class="line"><span style="color:#6A737D">// Render with different brand colors for each customer</span></span>
|
|
182
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> customer1</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template,</span></span>
|
|
183
|
-
<span class="line"><span style="color:#E1E4E8"> { title: </span><span style="color:#9ECBFF">'Welcome'</span><span style="color:#E1E4E8">, subtitle: </span><span style="color:#9ECBFF">'Customer 1'</span><span style="color:#E1E4E8"> },</span></span>
|
|
184
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
185
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
186
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
187
|
-
<span class="line"><span style="color:#E1E4E8"> brand: </span><span style="color:#9ECBFF">'#ef4444'</span><span style="color:#E1E4E8">,</span></span>
|
|
188
|
-
<span class="line"><span style="color:#E1E4E8"> background: </span><span style="color:#9ECBFF">'#fef2f2'</span><span style="color:#E1E4E8">,</span></span>
|
|
189
|
-
<span class="line"><span style="color:#E1E4E8"> foreground: </span><span style="color:#9ECBFF">'#7f1d1d'</span><span style="color:#E1E4E8">,</span></span>
|
|
190
|
-
<span class="line"><span style="color:#9ECBFF"> 'muted-foreground'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#991b1b'</span><span style="color:#E1E4E8">,</span></span>
|
|
191
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
192
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
193
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
194
|
-
<span class="line"><span style="color:#E1E4E8">);</span></span>
|
|
195
|
-
<span class="line"></span>
|
|
196
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> customer2</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template,</span></span>
|
|
197
|
-
<span class="line"><span style="color:#E1E4E8"> { title: </span><span style="color:#9ECBFF">'Welcome'</span><span style="color:#E1E4E8">, subtitle: </span><span style="color:#9ECBFF">'Customer 2'</span><span style="color:#E1E4E8"> },</span></span>
|
|
198
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
199
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
200
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
201
|
-
<span class="line"><span style="color:#E1E4E8"> brand: </span><span style="color:#9ECBFF">'#3b82f6'</span><span style="color:#E1E4E8">,</span></span>
|
|
202
|
-
<span class="line"><span style="color:#E1E4E8"> background: </span><span style="color:#9ECBFF">'#eff6ff'</span><span style="color:#E1E4E8">,</span></span>
|
|
203
|
-
<span class="line"><span style="color:#E1E4E8"> foreground: </span><span style="color:#9ECBFF">'#1e3a8a'</span><span style="color:#E1E4E8">,</span></span>
|
|
204
|
-
<span class="line"><span style="color:#9ECBFF"> 'muted-foreground'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#1e40af'</span><span style="color:#E1E4E8">,</span></span>
|
|
205
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
206
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
207
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
208
|
-
<span class="line"><span style="color:#E1E4E8">);</span></span>
|
|
209
|
-
<span class="line"></span></code></pre>
|
|
210
|
-
<h3 id="full-styleconfig-example">Full StyleConfig Example</h3>
|
|
211
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#F97583"> type</span><span style="color:#E1E4E8"> { StyleConfig } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
212
|
-
<span class="line"></span>
|
|
213
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> config</span><span style="color:#F97583">:</span><span style="color:#B392F0"> StyleConfig</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
214
|
-
<span class="line"><span style="color:#6A737D"> // Theme colors (any custom color names)</span></span>
|
|
215
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
216
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#6366f1'</span><span style="color:#E1E4E8">,</span></span>
|
|
217
|
-
<span class="line"><span style="color:#9ECBFF"> 'primary-foreground'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#ffffff'</span><span style="color:#E1E4E8">,</span></span>
|
|
218
|
-
<span class="line"><span style="color:#E1E4E8"> background: </span><span style="color:#9ECBFF">'#ffffff'</span><span style="color:#E1E4E8">,</span></span>
|
|
219
|
-
<span class="line"><span style="color:#E1E4E8"> foreground: </span><span style="color:#9ECBFF">'#0f172a'</span><span style="color:#E1E4E8">,</span></span>
|
|
220
|
-
<span class="line"><span style="color:#E1E4E8"> muted: </span><span style="color:#9ECBFF">'#f1f5f9'</span><span style="color:#E1E4E8">,</span></span>
|
|
221
|
-
<span class="line"><span style="color:#9ECBFF"> 'muted-foreground'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#64748b'</span><span style="color:#E1E4E8">,</span></span>
|
|
222
|
-
<span class="line"><span style="color:#E1E4E8"> border: </span><span style="color:#9ECBFF">'#e2e8f0'</span><span style="color:#E1E4E8">,</span></span>
|
|
223
|
-
<span class="line"><span style="color:#E1E4E8"> brand: </span><span style="color:#9ECBFF">'#8b5cf6'</span><span style="color:#E1E4E8">,</span></span>
|
|
224
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
225
|
-
<span class="line"></span>
|
|
226
|
-
<span class="line"><span style="color:#6A737D"> // Font families</span></span>
|
|
227
|
-
<span class="line"><span style="color:#E1E4E8"> fonts: {</span></span>
|
|
228
|
-
<span class="line"><span style="color:#E1E4E8"> sans: [</span><span style="color:#9ECBFF">'Inter'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'sans-serif'</span><span style="color:#E1E4E8">],</span></span>
|
|
229
|
-
<span class="line"><span style="color:#E1E4E8"> serif: [</span><span style="color:#9ECBFF">'Playfair Display'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'serif'</span><span style="color:#E1E4E8">],</span></span>
|
|
230
|
-
<span class="line"><span style="color:#E1E4E8"> mono: [</span><span style="color:#9ECBFF">'JetBrains Mono'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'monospace'</span><span style="color:#E1E4E8">],</span></span>
|
|
231
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
232
|
-
<span class="line"></span>
|
|
233
|
-
<span class="line"><span style="color:#6A737D"> // Custom tokens (optional)</span></span>
|
|
234
|
-
<span class="line"><span style="color:#E1E4E8"> tokens: {</span></span>
|
|
235
|
-
<span class="line"><span style="color:#E1E4E8"> borderRadius: {</span></span>
|
|
236
|
-
<span class="line"><span style="color:#E1E4E8"> sm: </span><span style="color:#9ECBFF">'0.25rem'</span><span style="color:#E1E4E8">,</span></span>
|
|
237
|
-
<span class="line"><span style="color:#E1E4E8"> md: </span><span style="color:#9ECBFF">'0.375rem'</span><span style="color:#E1E4E8">,</span></span>
|
|
238
|
-
<span class="line"><span style="color:#E1E4E8"> lg: </span><span style="color:#9ECBFF">'0.5rem'</span><span style="color:#E1E4E8">,</span></span>
|
|
239
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
240
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
241
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
242
|
-
<span class="line"></span></code></pre>
|
|
243
|
-
<h3 id="font-files">Font Files</h3>
|
|
244
|
-
<p>You can load custom fonts from local paths or external URLs:</p>
|
|
245
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> config</span><span style="color:#F97583">:</span><span style="color:#B392F0"> StyleConfig</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
246
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
247
|
-
<span class="line"><span style="color:#E1E4E8"> text: </span><span style="color:#9ECBFF">'#000000'</span><span style="color:#E1E4E8">,</span></span>
|
|
248
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
249
|
-
<span class="line"><span style="color:#E1E4E8"> fonts: {</span></span>
|
|
250
|
-
<span class="line"><span style="color:#E1E4E8"> sans: {</span></span>
|
|
251
|
-
<span class="line"><span style="color:#E1E4E8"> family: [</span><span style="color:#9ECBFF">'Inter'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'sans-serif'</span><span style="color:#E1E4E8">],</span></span>
|
|
252
|
-
<span class="line"><span style="color:#E1E4E8"> files: [</span></span>
|
|
253
|
-
<span class="line"><span style="color:#6A737D"> // Local font file (relative to your project)</span></span>
|
|
254
|
-
<span class="line"><span style="color:#E1E4E8"> { path: </span><span style="color:#9ECBFF">'./fonts/Inter-Regular.woff'</span><span style="color:#E1E4E8">, weight: </span><span style="color:#79B8FF">400</span><span style="color:#E1E4E8"> },</span></span>
|
|
255
|
-
<span class="line"><span style="color:#6A737D"> // External URL</span></span>
|
|
256
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
257
|
-
<span class="line"><span style="color:#E1E4E8"> path: </span><span style="color:#9ECBFF">'https://unpkg.com/@fontsource/inter@5.0.18/files/inter-latin-700-normal.woff'</span><span style="color:#E1E4E8">,</span></span>
|
|
258
|
-
<span class="line"><span style="color:#E1E4E8"> weight: </span><span style="color:#79B8FF">700</span></span>
|
|
259
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
260
|
-
<span class="line"><span style="color:#E1E4E8"> ]</span></span>
|
|
261
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
262
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
263
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
264
|
-
<span class="line"></span>
|
|
265
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplate</span><span style="color:#E1E4E8">({</span></span>
|
|
266
|
-
<span class="line"><span style="color:#E1E4E8"> config,</span></span>
|
|
267
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
268
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'font-sans'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
269
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'font-bold'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">Bold uses weight </span><span style="color:#79B8FF">700</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
270
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">p style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'font-normal'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">Normal uses weight </span><span style="color:#79B8FF">400</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">p</span><span style="color:#F97583">></span></span>
|
|
271
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
272
|
-
<span class="line"><span style="color:#E1E4E8"> ),</span></span>
|
|
273
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
274
|
-
<span class="line"></span></code></pre>
|
|
275
|
-
<p><strong>Supported formats:</strong></p>
|
|
276
|
-
<ul>
|
|
277
|
-
<li>✅ WOFF (<code>.woff</code>)</li>
|
|
278
|
-
<li>✅ TTF (<code>.ttf</code>)</li>
|
|
279
|
-
<li>✅ OTF (<code>.otf</code>)</li>
|
|
280
|
-
<li>❌ WOFF2 (not supported)</li>
|
|
281
|
-
</ul>
|
|
282
|
-
<h3 id="alternative-hardcoded-colors">Alternative: Hardcoded Colors</h3>
|
|
283
|
-
<p>If you prefer not to use config, you can still hardcode colors:</p>
|
|
284
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplate</span><span style="color:#E1E4E8">({</span></span>
|
|
285
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'og-image'</span><span style="color:#E1E4E8">,</span></span>
|
|
286
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
287
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
288
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'bg-[#3B82F6] text-white p-12'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
289
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-6xl font-bold'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">{title}</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
290
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
291
|
-
<span class="line"><span style="color:#E1E4E8"> ),</span></span>
|
|
292
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
293
|
-
<span class="line"></span></code></pre>
|
|
294
|
-
<h2 id="core-functions">Core Functions</h2>
|
|
295
|
-
<h3 id="definetemplatefromfile-recommended">defineTemplateFromFile() (Recommended)</h3>
|
|
296
|
-
<p>Load a template from a separate file (standard loopwind format):</p>
|
|
297
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="tsx"><code><span class="line"><span style="color:#6A737D">// _loopwind/templates/my-template/template.tsx</span></span>
|
|
298
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> const</span><span style="color:#79B8FF"> meta</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
299
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'my-template'</span><span style="color:#E1E4E8">,</span></span>
|
|
300
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'image'</span><span style="color:#F97583"> as</span><span style="color:#F97583"> const</span><span style="color:#E1E4E8">,</span></span>
|
|
301
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
302
|
-
<span class="line"><span style="color:#E1E4E8"> props: {</span></span>
|
|
303
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'string'</span><span style="color:#E1E4E8">,</span></span>
|
|
304
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
305
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
306
|
-
<span class="line"></span>
|
|
307
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> MyTemplate</span><span style="color:#E1E4E8">({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) {</span></span>
|
|
308
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> (</span></span>
|
|
309
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full bg-background'</span><span style="color:#E1E4E8">)}></span></span>
|
|
310
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">h1</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-6xl font-bold text-primary'</span><span style="color:#E1E4E8">)}>{title}</</span><span style="color:#85E89D">h1</span><span style="color:#E1E4E8">></span></span>
|
|
311
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
312
|
-
<span class="line"><span style="color:#E1E4E8"> );</span></span>
|
|
313
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
314
|
-
<span class="line"></span></code></pre>
|
|
315
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplateFromFile } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
316
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#79B8FF"> *</span><span style="color:#F97583"> as</span><span style="color:#E1E4E8"> myTemplate </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> './_loopwind/templates/my-template/template'</span><span style="color:#E1E4E8">;</span></span>
|
|
317
|
-
<span class="line"></span>
|
|
318
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplateFromFile</span><span style="color:#E1E4E8">(myTemplate, {</span></span>
|
|
319
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
320
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
321
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#3b82f6'</span><span style="color:#E1E4E8">,</span></span>
|
|
322
|
-
<span class="line"><span style="color:#E1E4E8"> background: </span><span style="color:#9ECBFF">'#ffffff'</span><span style="color:#E1E4E8">,</span></span>
|
|
323
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
324
|
-
<span class="line"><span style="color:#E1E4E8"> fonts: {</span></span>
|
|
325
|
-
<span class="line"><span style="color:#E1E4E8"> sans: [</span><span style="color:#9ECBFF">'Inter'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'sans-serif'</span><span style="color:#E1E4E8">],</span></span>
|
|
326
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
327
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
328
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
329
|
-
<span class="line"></span></code></pre>
|
|
330
|
-
<p><strong>Benefits:</strong></p>
|
|
331
|
-
<ul>
|
|
332
|
-
<li>✅ Reuse templates between CLI and SDK</li>
|
|
333
|
-
<li>✅ Clean separation of concerns</li>
|
|
334
|
-
<li>✅ Full JSX support with <code><div></code>, <code><h1></code>, etc.</li>
|
|
335
|
-
<li>✅ Standard loopwind format</li>
|
|
336
|
-
</ul>
|
|
337
|
-
<h3 id="definetemplate-alternative">defineTemplate() (Alternative)</h3>
|
|
338
|
-
<p>For inline templates without separate files:</p>
|
|
339
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplate } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
340
|
-
<span class="line"></span>
|
|
341
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplate</span><span style="color:#E1E4E8">({</span></span>
|
|
342
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'my-template'</span><span style="color:#E1E4E8">,</span></span>
|
|
343
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'image'</span><span style="color:#E1E4E8">,</span></span>
|
|
344
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
345
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
346
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
347
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#3b82f6'</span><span style="color:#E1E4E8">,</span></span>
|
|
348
|
-
<span class="line"><span style="color:#E1E4E8"> background: </span><span style="color:#9ECBFF">'#ffffff'</span><span style="color:#E1E4E8">,</span></span>
|
|
349
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
350
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
351
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
352
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full bg-background'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
353
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-6xl font-bold text-primary'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">{title}</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
354
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
355
|
-
<span class="line"><span style="color:#E1E4E8"> ),</span></span>
|
|
356
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
357
|
-
<span class="line"></span></code></pre>
|
|
358
|
-
<p><strong>Use when:</strong></p>
|
|
359
|
-
<ul>
|
|
360
|
-
<li>Simple, one-off templates</li>
|
|
361
|
-
<li>No need to reuse in CLI</li>
|
|
362
|
-
<li>Keeping everything in one file</li>
|
|
363
|
-
</ul>
|
|
364
|
-
<h3 id="renderimage">renderImage()</h3>
|
|
365
|
-
<p>Render an image template to a Buffer:</p>
|
|
366
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { renderImage } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
367
|
-
<span class="line"></span>
|
|
368
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> buffer</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template, props, {</span></span>
|
|
369
|
-
<span class="line"><span style="color:#E1E4E8"> format: </span><span style="color:#9ECBFF">'png'</span><span style="color:#E1E4E8">, </span><span style="color:#6A737D">// 'png', 'jpeg', 'jpg', 'webp', 'svg'</span></span>
|
|
370
|
-
<span class="line"><span style="color:#E1E4E8"> quality: </span><span style="color:#79B8FF">92</span><span style="color:#E1E4E8">, </span><span style="color:#6A737D">// JPEG/WebP quality (1-100)</span></span>
|
|
371
|
-
<span class="line"><span style="color:#E1E4E8"> config: { </span><span style="color:#6A737D">// Optional: Override template config</span></span>
|
|
372
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
373
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#8b5cf6'</span><span style="color:#E1E4E8">,</span></span>
|
|
374
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
375
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
376
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
377
|
-
<span class="line"></span></code></pre>
|
|
378
|
-
<p><strong>Supported formats:</strong></p>
|
|
379
|
-
<ul>
|
|
380
|
-
<li><code>png</code> - Best for graphics with transparency</li>
|
|
381
|
-
<li><code>jpeg</code>/<code>jpg</code> - Smaller file size for photos</li>
|
|
382
|
-
<li><code>webp</code> - Modern format, good compression</li>
|
|
383
|
-
<li><code>svg</code> - Vector format, infinitely scalable</li>
|
|
384
|
-
</ul>
|
|
385
|
-
<h3 id="rendervideo">renderVideo()</h3>
|
|
386
|
-
<p>Render a video template to an MP4 Buffer:</p>
|
|
387
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { renderVideo } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
388
|
-
<span class="line"></span>
|
|
389
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> buffer</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderVideo</span><span style="color:#E1E4E8">(template, props, {</span></span>
|
|
390
|
-
<span class="line"><span style="color:#E1E4E8"> quality: </span><span style="color:#79B8FF">23</span><span style="color:#E1E4E8">, </span><span style="color:#6A737D">// H.264 quality (0-51, lower = better)</span></span>
|
|
391
|
-
<span class="line"><span style="color:#B392F0"> onProgress</span><span style="color:#E1E4E8">: (</span><span style="color:#FFAB70">frame</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">total</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">phase</span><span style="color:#E1E4E8">) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> {</span></span>
|
|
392
|
-
<span class="line"><span style="color:#E1E4E8"> console.</span><span style="color:#B392F0">log</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">`${</span><span style="color:#E1E4E8">phase</span><span style="color:#9ECBFF">}: ${</span><span style="color:#E1E4E8">frame</span><span style="color:#9ECBFF">}/${</span><span style="color:#E1E4E8">total</span><span style="color:#9ECBFF">}`</span><span style="color:#E1E4E8">);</span></span>
|
|
393
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
394
|
-
<span class="line"><span style="color:#E1E4E8"> config: { </span><span style="color:#6A737D">// Optional: Override template config</span></span>
|
|
395
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
396
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#8b5cf6'</span><span style="color:#E1E4E8">,</span></span>
|
|
397
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
398
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
399
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
400
|
-
<span class="line"></span></code></pre>
|
|
401
|
-
<h2 id="template-organization">Template Organization</h2>
|
|
402
|
-
<h3 id="project-structure">Project Structure</h3>
|
|
403
|
-
<p>Recommended structure for using templates in your project:</p>
|
|
404
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="plaintext"><code><span class="line"><span>my-project/</span></span>
|
|
405
|
-
<span class="line"><span>├── _loopwind/</span></span>
|
|
406
|
-
<span class="line"><span>│ ├── loopwind.json # Optional: shared config</span></span>
|
|
407
|
-
<span class="line"><span>│ └── templates/</span></span>
|
|
408
|
-
<span class="line"><span>│ ├── og-image/</span></span>
|
|
409
|
-
<span class="line"><span>│ │ └── template.tsx # Image template</span></span>
|
|
410
|
-
<span class="line"><span>│ └── intro-video/</span></span>
|
|
411
|
-
<span class="line"><span>│ └── template.tsx # Video template</span></span>
|
|
412
|
-
<span class="line"><span>├── pages/</span></span>
|
|
413
|
-
<span class="line"><span>│ └── api/</span></span>
|
|
414
|
-
<span class="line"><span>│ ├── og-image.ts # API route using og-image</span></span>
|
|
415
|
-
<span class="line"><span>│ └── intro-video.ts # API route using intro-video</span></span>
|
|
416
|
-
<span class="line"><span>└── package.json</span></span>
|
|
417
|
-
<span class="line"><span></span></span></code></pre>
|
|
418
|
-
<p>Or with a top-level <code>templates/</code> folder (like in Astro):</p>
|
|
419
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="plaintext"><code><span class="line"><span>my-project/</span></span>
|
|
420
|
-
<span class="line"><span>├── templates/</span></span>
|
|
421
|
-
<span class="line"><span>│ ├── og-image.tsx # Image template</span></span>
|
|
422
|
-
<span class="line"><span>│ └── intro-video.tsx # Video template</span></span>
|
|
423
|
-
<span class="line"><span>├── src/</span></span>
|
|
424
|
-
<span class="line"><span>│ └── pages/</span></span>
|
|
425
|
-
<span class="line"><span>│ └── api/</span></span>
|
|
426
|
-
<span class="line"><span>│ └── og/</span></span>
|
|
427
|
-
<span class="line"><span>│ └── [slug].ts # API route</span></span>
|
|
428
|
-
<span class="line"><span>└── tsconfig.json # With path aliases</span></span>
|
|
429
|
-
<span class="line"><span></span></span></code></pre>
|
|
430
|
-
<h3 id="path-aliases-recommended">Path Aliases (Recommended)</h3>
|
|
431
|
-
<p>Use TypeScript path aliases for cleaner imports:</p>
|
|
432
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="json"><code><span class="line"><span style="color:#6A737D">// tsconfig.json</span></span>
|
|
433
|
-
<span class="line"><span style="color:#E1E4E8">{</span></span>
|
|
434
|
-
<span class="line"><span style="color:#79B8FF"> "compilerOptions"</span><span style="color:#E1E4E8">: {</span></span>
|
|
435
|
-
<span class="line"><span style="color:#79B8FF"> "baseUrl"</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">"."</span><span style="color:#E1E4E8">,</span></span>
|
|
436
|
-
<span class="line"><span style="color:#79B8FF"> "paths"</span><span style="color:#E1E4E8">: {</span></span>
|
|
437
|
-
<span class="line"><span style="color:#79B8FF"> "@templates/*"</span><span style="color:#E1E4E8">: [</span><span style="color:#9ECBFF">"_loopwind/templates/*"</span><span style="color:#E1E4E8">],</span></span>
|
|
438
|
-
<span class="line"><span style="color:#79B8FF"> "@/*"</span><span style="color:#E1E4E8">: [</span><span style="color:#9ECBFF">"src/*"</span><span style="color:#E1E4E8">]</span></span>
|
|
439
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
440
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
441
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
442
|
-
<span class="line"></span></code></pre>
|
|
443
|
-
<p>Then import with clean paths:</p>
|
|
444
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#79B8FF"> *</span><span style="color:#F97583"> as</span><span style="color:#E1E4E8"> ogTemplate </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> '@templates/og-image/template'</span><span style="color:#E1E4E8">;</span></span>
|
|
445
|
-
<span class="line"></span></code></pre>
|
|
446
|
-
<h3 id="sharing-templates">Sharing Templates</h3>
|
|
447
|
-
<p>Templates are <strong>portable</strong> - copy the template folder to share between projects:</p>
|
|
448
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#6A737D"># Copy template to another project</span></span>
|
|
449
|
-
<span class="line"><span style="color:#B392F0">cp</span><span style="color:#79B8FF"> -r</span><span style="color:#9ECBFF"> _loopwind/templates/og-image</span><span style="color:#9ECBFF"> ../other-project/_loopwind/templates/</span></span>
|
|
450
|
-
<span class="line"></span>
|
|
451
|
-
<span class="line"><span style="color:#6A737D"># Or publish as npm package</span></span>
|
|
452
|
-
<span class="line"><span style="color:#B392F0">npm</span><span style="color:#9ECBFF"> publish</span><span style="color:#9ECBFF"> loopwind-templates</span></span>
|
|
453
|
-
<span class="line"></span></code></pre>
|
|
454
|
-
<h2 id="user-generated-templates">User-Generated Templates</h2>
|
|
455
|
-
<p>Build template editors where users create templates without writing code!</p>
|
|
456
|
-
<h3 id="code-editor-definetemplatefromsource">Code Editor (defineTemplateFromSource)</h3>
|
|
457
|
-
<p>For code editors where users write template source as strings:</p>
|
|
458
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplateFromSource, renderImage } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
459
|
-
<span class="line"></span>
|
|
460
|
-
<span class="line"><span style="color:#6A737D">// User writes template code in Monaco Editor, CodeMirror, etc.</span></span>
|
|
461
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> userCode</span><span style="color:#F97583"> =</span><span style="color:#9ECBFF"> `</span></span>
|
|
462
|
-
<span class="line"><span style="color:#9ECBFF">export const meta = {</span></span>
|
|
463
|
-
<span class="line"><span style="color:#9ECBFF"> name: 'user-card',</span></span>
|
|
464
|
-
<span class="line"><span style="color:#9ECBFF"> type: 'image',</span></span>
|
|
465
|
-
<span class="line"><span style="color:#9ECBFF"> size: { width: 1200, height: 630 }</span></span>
|
|
466
|
-
<span class="line"><span style="color:#9ECBFF">};</span></span>
|
|
467
|
-
<span class="line"></span>
|
|
468
|
-
<span class="line"><span style="color:#9ECBFF">export default ({ tw, title, description }) => (</span></span>
|
|
469
|
-
<span class="line"><span style="color:#9ECBFF"> <div style={tw('flex flex-col w-full h-full bg-gradient-to-br from-blue-600 to-purple-700 p-12')}></span></span>
|
|
470
|
-
<span class="line"><span style="color:#9ECBFF"> <h1 style={tw('text-6xl font-bold text-white')}>{title}</h1></span></span>
|
|
471
|
-
<span class="line"><span style="color:#9ECBFF"> <p style={tw('text-2xl text-white/80')}>{description}</p></span></span>
|
|
472
|
-
<span class="line"><span style="color:#9ECBFF"> </div></span></span>
|
|
473
|
-
<span class="line"><span style="color:#9ECBFF">);</span></span>
|
|
474
|
-
<span class="line"><span style="color:#9ECBFF">`</span><span style="color:#E1E4E8">;</span></span>
|
|
475
|
-
<span class="line"></span>
|
|
476
|
-
<span class="line"><span style="color:#6A737D">// Create template from source string</span></span>
|
|
477
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplateFromSource</span><span style="color:#E1E4E8">(userCode, {</span></span>
|
|
478
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
479
|
-
<span class="line"><span style="color:#E1E4E8"> colors: { primary: </span><span style="color:#9ECBFF">'#3b82f6'</span><span style="color:#E1E4E8"> }</span></span>
|
|
480
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
481
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
482
|
-
<span class="line"></span>
|
|
483
|
-
<span class="line"><span style="color:#6A737D">// Render</span></span>
|
|
484
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> png</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template, {</span></span>
|
|
485
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'User Created'</span><span style="color:#E1E4E8">,</span></span>
|
|
486
|
-
<span class="line"><span style="color:#E1E4E8"> description: </span><span style="color:#9ECBFF">'From code editor'</span></span>
|
|
487
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
488
|
-
<span class="line"></span></code></pre>
|
|
489
|
-
<p><strong>⚠️ Security Warning:</strong></p>
|
|
490
|
-
<p><code>defineTemplateFromSource()</code> uses <code>new Function()</code> to evaluate code strings. <strong>Only use with trusted sources!</strong> Never pass untrusted user input directly.</p>
|
|
491
|
-
<p><strong>Safe use cases:</strong></p>
|
|
492
|
-
<ul>
|
|
493
|
-
<li>Admin-created templates stored in database</li>
|
|
494
|
-
<li>Templates from authenticated, trusted users</li>
|
|
495
|
-
<li>Code editor with validation/sandboxing</li>
|
|
496
|
-
</ul>
|
|
497
|
-
<p><strong>Template format:</strong></p>
|
|
498
|
-
<ul>
|
|
499
|
-
<li>Must export <code>meta</code> object with <code>name</code>, <code>size</code>, and optional <code>type</code>/<code>video</code></li>
|
|
500
|
-
<li>Must have <code>export default</code> render function</li>
|
|
501
|
-
<li><strong>Supports JSX syntax!</strong> Write normal React components with <code><div></code>, <code><h1></code>, etc.</li>
|
|
502
|
-
<li>Props use curly braces: <code>style={tw('...')}</code>, <code>{title}</code></li>
|
|
503
|
-
</ul>
|
|
504
|
-
<h3 id="visual-builder-definetemplatefromschema">Visual Builder (defineTemplateFromSchema)</h3>
|
|
505
|
-
<p>For drag-and-drop template builders with JSON schemas:</p>
|
|
506
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplateFromSchema, renderImage, </span><span style="color:#F97583">type</span><span style="color:#E1E4E8"> TemplateSchema } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
507
|
-
<span class="line"></span>
|
|
508
|
-
<span class="line"><span style="color:#6A737D">// Schema generated by visual builder UI</span></span>
|
|
509
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> schema</span><span style="color:#F97583">:</span><span style="color:#B392F0"> TemplateSchema</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
510
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'visual-card'</span><span style="color:#E1E4E8">,</span></span>
|
|
511
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
512
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
513
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
514
|
-
<span class="line"><span style="color:#E1E4E8"> primary: </span><span style="color:#9ECBFF">'#3b82f6'</span><span style="color:#E1E4E8">,</span></span>
|
|
515
|
-
<span class="line"><span style="color:#E1E4E8"> background: </span><span style="color:#9ECBFF">'#ffffff'</span><span style="color:#E1E4E8">,</span></span>
|
|
516
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
517
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
518
|
-
<span class="line"><span style="color:#E1E4E8"> elements: [</span></span>
|
|
519
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
520
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'div'</span><span style="color:#E1E4E8">,</span></span>
|
|
521
|
-
<span class="line"><span style="color:#E1E4E8"> className: </span><span style="color:#9ECBFF">'flex flex-col w-full h-full bg-background p-12 justify-center'</span><span style="color:#E1E4E8">,</span></span>
|
|
522
|
-
<span class="line"><span style="color:#E1E4E8"> children: [</span></span>
|
|
523
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
524
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'h1'</span><span style="color:#E1E4E8">,</span></span>
|
|
525
|
-
<span class="line"><span style="color:#E1E4E8"> className: </span><span style="color:#9ECBFF">'text-6xl font-bold text-primary mb-4'</span><span style="color:#E1E4E8">,</span></span>
|
|
526
|
-
<span class="line"><span style="color:#E1E4E8"> content: </span><span style="color:#9ECBFF">'{{title}}'</span><span style="color:#E1E4E8">, </span><span style="color:#6A737D">// Variable interpolation</span></span>
|
|
527
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
528
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
529
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'p'</span><span style="color:#E1E4E8">,</span></span>
|
|
530
|
-
<span class="line"><span style="color:#E1E4E8"> className: </span><span style="color:#9ECBFF">'text-2xl text-gray-600'</span><span style="color:#E1E4E8">,</span></span>
|
|
531
|
-
<span class="line"><span style="color:#E1E4E8"> content: </span><span style="color:#9ECBFF">'{{description}}'</span><span style="color:#E1E4E8">,</span></span>
|
|
532
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
533
|
-
<span class="line"><span style="color:#E1E4E8"> ],</span></span>
|
|
534
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
535
|
-
<span class="line"><span style="color:#E1E4E8"> ],</span></span>
|
|
536
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
537
|
-
<span class="line"></span>
|
|
538
|
-
<span class="line"><span style="color:#6A737D">// Create template from schema</span></span>
|
|
539
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplateFromSchema</span><span style="color:#E1E4E8">(schema);</span></span>
|
|
540
|
-
<span class="line"></span>
|
|
541
|
-
<span class="line"><span style="color:#6A737D">// Render with props</span></span>
|
|
542
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> png</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template, {</span></span>
|
|
543
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'Built Visually'</span><span style="color:#E1E4E8">,</span></span>
|
|
544
|
-
<span class="line"><span style="color:#E1E4E8"> description: </span><span style="color:#9ECBFF">'No code required!'</span></span>
|
|
545
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
546
|
-
<span class="line"></span></code></pre>
|
|
547
|
-
<p><strong>Schema Features:</strong></p>
|
|
548
|
-
<ul>
|
|
549
|
-
<li><strong>Elements:</strong> Supports <code>div</code>, <code>span</code>, <code>h1</code>-<code>h6</code>, <code>p</code>, <code>img</code></li>
|
|
550
|
-
<li><strong>Styling:</strong> Use <code>className</code> for Tailwind classes or <code>style</code> for inline styles</li>
|
|
551
|
-
<li><strong>Variables:</strong> Use <code>{{variableName}}</code> in <code>content</code> or <code>src</code> for dynamic values</li>
|
|
552
|
-
<li><strong>Nesting:</strong> Unlimited nested <code>children</code> arrays</li>
|
|
553
|
-
<li><strong>Type-safe:</strong> Full TypeScript support with <code>TemplateSchema</code> type</li>
|
|
554
|
-
</ul>
|
|
555
|
-
<p><strong>Example with dynamic branding:</strong></p>
|
|
556
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> brandedSchema</span><span style="color:#F97583">:</span><span style="color:#B392F0"> TemplateSchema</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
557
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'branded'</span><span style="color:#E1E4E8">,</span></span>
|
|
558
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
559
|
-
<span class="line"><span style="color:#E1E4E8"> elements: [</span></span>
|
|
560
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
561
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'div'</span><span style="color:#E1E4E8">,</span></span>
|
|
562
|
-
<span class="line"><span style="color:#E1E4E8"> className: </span><span style="color:#9ECBFF">'flex w-full h-full bg-brand-bg p-12'</span><span style="color:#E1E4E8">,</span></span>
|
|
563
|
-
<span class="line"><span style="color:#E1E4E8"> children: [</span></span>
|
|
564
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
565
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'div'</span><span style="color:#E1E4E8">,</span></span>
|
|
566
|
-
<span class="line"><span style="color:#E1E4E8"> className: </span><span style="color:#9ECBFF">'w-16 h-16 rounded-full bg-brand-primary'</span><span style="color:#E1E4E8">,</span></span>
|
|
567
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
568
|
-
<span class="line"><span style="color:#E1E4E8"> {</span></span>
|
|
569
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'h1'</span><span style="color:#E1E4E8">,</span></span>
|
|
570
|
-
<span class="line"><span style="color:#E1E4E8"> className: </span><span style="color:#9ECBFF">'text-6xl font-bold text-brand-text'</span><span style="color:#E1E4E8">,</span></span>
|
|
571
|
-
<span class="line"><span style="color:#E1E4E8"> content: </span><span style="color:#9ECBFF">'{{companyName}}'</span><span style="color:#E1E4E8">,</span></span>
|
|
572
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
573
|
-
<span class="line"><span style="color:#E1E4E8"> ],</span></span>
|
|
574
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
575
|
-
<span class="line"><span style="color:#E1E4E8"> ],</span></span>
|
|
576
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
577
|
-
<span class="line"></span>
|
|
578
|
-
<span class="line"><span style="color:#6A737D">// Render with different brands</span></span>
|
|
579
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> brand1</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(</span></span>
|
|
580
|
-
<span class="line"><span style="color:#B392F0"> defineTemplateFromSchema</span><span style="color:#E1E4E8">({</span></span>
|
|
581
|
-
<span class="line"><span style="color:#F97583"> ...</span><span style="color:#E1E4E8">brandedSchema,</span></span>
|
|
582
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
583
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
584
|
-
<span class="line"><span style="color:#9ECBFF"> 'brand-primary'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#3b82f6'</span><span style="color:#E1E4E8">,</span></span>
|
|
585
|
-
<span class="line"><span style="color:#9ECBFF"> 'brand-bg'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#eff6ff'</span><span style="color:#E1E4E8">,</span></span>
|
|
586
|
-
<span class="line"><span style="color:#9ECBFF"> 'brand-text'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#1e3a8a'</span><span style="color:#E1E4E8">,</span></span>
|
|
587
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
588
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
589
|
-
<span class="line"><span style="color:#E1E4E8"> }),</span></span>
|
|
590
|
-
<span class="line"><span style="color:#E1E4E8"> { companyName: </span><span style="color:#9ECBFF">'TechCorp'</span><span style="color:#E1E4E8"> }</span></span>
|
|
591
|
-
<span class="line"><span style="color:#E1E4E8">);</span></span>
|
|
592
|
-
<span class="line"></span>
|
|
593
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> brand2</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(</span></span>
|
|
594
|
-
<span class="line"><span style="color:#B392F0"> defineTemplateFromSchema</span><span style="color:#E1E4E8">({</span></span>
|
|
595
|
-
<span class="line"><span style="color:#F97583"> ...</span><span style="color:#E1E4E8">brandedSchema,</span></span>
|
|
596
|
-
<span class="line"><span style="color:#E1E4E8"> config: {</span></span>
|
|
597
|
-
<span class="line"><span style="color:#E1E4E8"> colors: {</span></span>
|
|
598
|
-
<span class="line"><span style="color:#9ECBFF"> 'brand-primary'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#8b5cf6'</span><span style="color:#E1E4E8">,</span></span>
|
|
599
|
-
<span class="line"><span style="color:#9ECBFF"> 'brand-bg'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#faf5ff'</span><span style="color:#E1E4E8">,</span></span>
|
|
600
|
-
<span class="line"><span style="color:#9ECBFF"> 'brand-text'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#581c87'</span><span style="color:#E1E4E8">,</span></span>
|
|
601
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
602
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
603
|
-
<span class="line"><span style="color:#E1E4E8"> }),</span></span>
|
|
604
|
-
<span class="line"><span style="color:#E1E4E8"> { companyName: </span><span style="color:#9ECBFF">'DesignStudio'</span><span style="color:#E1E4E8"> }</span></span>
|
|
605
|
-
<span class="line"><span style="color:#E1E4E8">);</span></span>
|
|
606
|
-
<span class="line"></span></code></pre>
|
|
607
|
-
<p><strong>Benefits:</strong></p>
|
|
608
|
-
<ul>
|
|
609
|
-
<li>✅ <strong>Safe</strong> - No code execution, just JSON</li>
|
|
610
|
-
<li>✅ <strong>User-friendly</strong> - Perfect for drag-and-drop builders</li>
|
|
611
|
-
<li>✅ <strong>Dynamic</strong> - Variable interpolation with <code>{{}}</code> syntax</li>
|
|
612
|
-
<li>✅ <strong>Flexible</strong> - Support images, styles, nesting</li>
|
|
613
|
-
<li>✅ <strong>Type-safe</strong> - Full TypeScript support</li>
|
|
614
|
-
</ul>
|
|
615
|
-
<h2 id="nextjs-api-routes">Next.js API Routes</h2>
|
|
616
|
-
<h3 id="image-generation">Image Generation</h3>
|
|
617
|
-
<p>Create your template:</p>
|
|
618
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="tsx"><code><span class="line"><span style="color:#6A737D">// _loopwind/templates/og-image/template.tsx</span></span>
|
|
619
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> const</span><span style="color:#79B8FF"> meta</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
620
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'og-image'</span><span style="color:#E1E4E8">,</span></span>
|
|
621
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'image'</span><span style="color:#F97583"> as</span><span style="color:#F97583"> const</span><span style="color:#E1E4E8">,</span></span>
|
|
622
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
623
|
-
<span class="line"><span style="color:#E1E4E8"> props: {</span></span>
|
|
624
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'string'</span><span style="color:#E1E4E8">,</span></span>
|
|
625
|
-
<span class="line"><span style="color:#E1E4E8"> description: </span><span style="color:#9ECBFF">'string'</span><span style="color:#E1E4E8">,</span></span>
|
|
626
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
627
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
628
|
-
<span class="line"></span>
|
|
629
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> OgImage</span><span style="color:#E1E4E8">({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">description</span><span style="color:#E1E4E8"> }) {</span></span>
|
|
630
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> (</span></span>
|
|
631
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex flex-col w-full h-full bg-gradient-to-br from-blue-600 to-purple-700 p-12 justify-between'</span><span style="color:#E1E4E8">)}></span></span>
|
|
632
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center gap-4'</span><span style="color:#E1E4E8">)}></span></span>
|
|
633
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'w-12 h-12 rounded-full bg-white/20'</span><span style="color:#E1E4E8">)} /></span></span>
|
|
634
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">span</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-white/80 text-2xl'</span><span style="color:#E1E4E8">)}>yoursite.com</</span><span style="color:#85E89D">span</span><span style="color:#E1E4E8">></span></span>
|
|
635
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
636
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
637
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">h1</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-6xl font-bold text-white mb-4'</span><span style="color:#E1E4E8">)}>{title}</</span><span style="color:#85E89D">h1</span><span style="color:#E1E4E8">></span></span>
|
|
638
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">p</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-2xl text-white/80'</span><span style="color:#E1E4E8">)}>{description}</</span><span style="color:#85E89D">p</span><span style="color:#E1E4E8">></span></span>
|
|
639
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
640
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
641
|
-
<span class="line"><span style="color:#E1E4E8"> );</span></span>
|
|
642
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
643
|
-
<span class="line"></span></code></pre>
|
|
644
|
-
<p>Use it in your API route:</p>
|
|
645
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#6A737D">// pages/api/og-image.ts</span></span>
|
|
646
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#F97583"> type</span><span style="color:#E1E4E8"> { NextApiRequest, NextApiResponse } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'next'</span><span style="color:#E1E4E8">;</span></span>
|
|
647
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplateFromFile, renderImage } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
648
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#79B8FF"> *</span><span style="color:#F97583"> as</span><span style="color:#E1E4E8"> ogTemplate </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> '../../_loopwind/templates/og-image/template'</span><span style="color:#E1E4E8">;</span></span>
|
|
649
|
-
<span class="line"></span>
|
|
650
|
-
<span class="line"><span style="color:#6A737D">// Load template once at module level (cached)</span></span>
|
|
651
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplateFromFile</span><span style="color:#E1E4E8">(ogTemplate);</span></span>
|
|
652
|
-
<span class="line"></span>
|
|
653
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> async</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> handler</span><span style="color:#E1E4E8">(</span><span style="color:#FFAB70">req</span><span style="color:#F97583">:</span><span style="color:#B392F0"> NextApiRequest</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">res</span><span style="color:#F97583">:</span><span style="color:#B392F0"> NextApiResponse</span><span style="color:#E1E4E8">) {</span></span>
|
|
654
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#E1E4E8"> { </span><span style="color:#79B8FF">title</span><span style="color:#F97583"> =</span><span style="color:#9ECBFF"> 'Welcome'</span><span style="color:#E1E4E8">, </span><span style="color:#79B8FF">description</span><span style="color:#F97583"> =</span><span style="color:#9ECBFF"> 'Generated with loopwind'</span><span style="color:#E1E4E8"> } </span><span style="color:#F97583">=</span><span style="color:#E1E4E8"> req.query;</span></span>
|
|
655
|
-
<span class="line"></span>
|
|
656
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#79B8FF"> png</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template, {</span></span>
|
|
657
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#B392F0">String</span><span style="color:#E1E4E8">(title),</span></span>
|
|
658
|
-
<span class="line"><span style="color:#E1E4E8"> description: </span><span style="color:#B392F0">String</span><span style="color:#E1E4E8">(description),</span></span>
|
|
659
|
-
<span class="line"><span style="color:#E1E4E8"> });</span></span>
|
|
660
|
-
<span class="line"></span>
|
|
661
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">setHeader</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'Content-Type'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'image/png'</span><span style="color:#E1E4E8">);</span></span>
|
|
662
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">setHeader</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'Cache-Control'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'s-maxage=86400, stale-while-revalidate'</span><span style="color:#E1E4E8">);</span></span>
|
|
663
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">send</span><span style="color:#E1E4E8">(png);</span></span>
|
|
664
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
665
|
-
<span class="line"></span></code></pre>
|
|
666
|
-
<p><strong>Usage:</strong></p>
|
|
667
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="plaintext"><code><span class="line"><span>https://yoursite.com/api/og-image?title=Hello&description=World</span></span>
|
|
668
|
-
<span class="line"><span></span></span></code></pre>
|
|
669
|
-
<h3 id="video-generation">Video Generation</h3>
|
|
670
|
-
<p>Create your template:</p>
|
|
671
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="tsx"><code><span class="line"><span style="color:#6A737D">// _loopwind/templates/intro-video/template.tsx</span></span>
|
|
672
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> const</span><span style="color:#79B8FF"> meta</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
673
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'intro-video'</span><span style="color:#E1E4E8">,</span></span>
|
|
674
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'video'</span><span style="color:#F97583"> as</span><span style="color:#F97583"> const</span><span style="color:#E1E4E8">,</span></span>
|
|
675
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1920</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">1080</span><span style="color:#E1E4E8"> },</span></span>
|
|
676
|
-
<span class="line"><span style="color:#E1E4E8"> video: { fps: </span><span style="color:#79B8FF">30</span><span style="color:#E1E4E8">, duration: </span><span style="color:#79B8FF">3</span><span style="color:#E1E4E8"> },</span></span>
|
|
677
|
-
<span class="line"><span style="color:#E1E4E8"> props: {</span></span>
|
|
678
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'string'</span><span style="color:#E1E4E8">,</span></span>
|
|
679
|
-
<span class="line"><span style="color:#E1E4E8"> },</span></span>
|
|
680
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
681
|
-
<span class="line"></span>
|
|
682
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> IntroVideo</span><span style="color:#E1E4E8">({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) {</span></span>
|
|
683
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> (</span></span>
|
|
684
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">div</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full bg-gradient-to-br from-black to-gray-900'</span><span style="color:#E1E4E8">)}></span></span>
|
|
685
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#6A737D">/* Fade in animation using utility classes */</span><span style="color:#E1E4E8">}</span></span>
|
|
686
|
-
<span class="line"><span style="color:#E1E4E8"> <</span><span style="color:#85E89D">h1</span><span style="color:#B392F0"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-8xl font-bold text-white enter-fade-in/0/1500'</span><span style="color:#E1E4E8">)}></span></span>
|
|
687
|
-
<span class="line"><span style="color:#E1E4E8"> {title}</span></span>
|
|
688
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">h1</span><span style="color:#E1E4E8">></span></span>
|
|
689
|
-
<span class="line"><span style="color:#E1E4E8"> </</span><span style="color:#85E89D">div</span><span style="color:#E1E4E8">></span></span>
|
|
690
|
-
<span class="line"><span style="color:#E1E4E8"> );</span></span>
|
|
691
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
692
|
-
<span class="line"></span></code></pre>
|
|
693
|
-
<p>Use it in your API route:</p>
|
|
694
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#6A737D">// pages/api/intro-video.ts</span></span>
|
|
695
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#F97583"> type</span><span style="color:#E1E4E8"> { NextApiRequest, NextApiResponse } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'next'</span><span style="color:#E1E4E8">;</span></span>
|
|
696
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplateFromFile, renderVideo } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
697
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#79B8FF"> *</span><span style="color:#F97583"> as</span><span style="color:#E1E4E8"> introTemplate </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> '../../_loopwind/templates/intro-video/template'</span><span style="color:#E1E4E8">;</span></span>
|
|
698
|
-
<span class="line"></span>
|
|
699
|
-
<span class="line"><span style="color:#6A737D">// Load template once at module level (cached)</span></span>
|
|
700
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplateFromFile</span><span style="color:#E1E4E8">(introTemplate);</span></span>
|
|
701
|
-
<span class="line"></span>
|
|
702
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> async</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> handler</span><span style="color:#E1E4E8">(</span><span style="color:#FFAB70">req</span><span style="color:#F97583">:</span><span style="color:#B392F0"> NextApiRequest</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">res</span><span style="color:#F97583">:</span><span style="color:#B392F0"> NextApiResponse</span><span style="color:#E1E4E8">) {</span></span>
|
|
703
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#E1E4E8"> { </span><span style="color:#79B8FF">title</span><span style="color:#F97583"> =</span><span style="color:#9ECBFF"> 'Welcome!'</span><span style="color:#E1E4E8"> } </span><span style="color:#F97583">=</span><span style="color:#E1E4E8"> req.query;</span></span>
|
|
704
|
-
<span class="line"></span>
|
|
705
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#79B8FF"> mp4</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderVideo</span><span style="color:#E1E4E8">(template, {</span></span>
|
|
706
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#B392F0">String</span><span style="color:#E1E4E8">(title),</span></span>
|
|
707
|
-
<span class="line"><span style="color:#E1E4E8"> });</span></span>
|
|
708
|
-
<span class="line"></span>
|
|
709
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">setHeader</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'Content-Type'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'video/mp4'</span><span style="color:#E1E4E8">);</span></span>
|
|
710
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">setHeader</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'Cache-Control'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'s-maxage=3600'</span><span style="color:#E1E4E8">);</span></span>
|
|
711
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">send</span><span style="color:#E1E4E8">(mp4);</span></span>
|
|
712
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
713
|
-
<span class="line"></span></code></pre>
|
|
714
|
-
<h2 id="template-props">Template Props</h2>
|
|
715
|
-
<p>Templates receive these props in their render function:</p>
|
|
716
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({</span></span>
|
|
717
|
-
<span class="line"><span style="color:#E1E4E8"> tw, </span><span style="color:#6A737D">// Tailwind style function</span></span>
|
|
718
|
-
<span class="line"><span style="color:#E1E4E8"> qr, </span><span style="color:#6A737D">// QR code generator</span></span>
|
|
719
|
-
<span class="line"><span style="color:#E1E4E8"> image, </span><span style="color:#6A737D">// Image embedding helper</span></span>
|
|
720
|
-
<span class="line"><span style="color:#E1E4E8"> template, </span><span style="color:#6A737D">// Template composition helper</span></span>
|
|
721
|
-
<span class="line"><span style="color:#E1E4E8"> frame, </span><span style="color:#6A737D">// Current frame (video only)</span></span>
|
|
722
|
-
<span class="line"><span style="color:#E1E4E8"> progress, </span><span style="color:#6A737D">// Progress 0-1 (video only)</span></span>
|
|
723
|
-
<span class="line"><span style="color:#F97583"> ...</span><span style="color:#E1E4E8">props </span><span style="color:#6A737D">// Your custom props</span></span>
|
|
724
|
-
<span class="line"><span style="color:#E1E4E8">}) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span><span style="color:#6A737D">/* JSX */</span><span style="color:#E1E4E8">)</span></span>
|
|
725
|
-
<span class="line"></span></code></pre>
|
|
726
|
-
<h3 id="using-tw">Using tw()</h3>
|
|
727
|
-
<p>The <code>tw</code> function converts Tailwind classes to inline styles:</p>
|
|
728
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
729
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex flex-col gap-4 p-8 bg-gradient-to-br from-blue-600 to-purple-700'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
730
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-6xl font-bold text-white'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">{title}</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
731
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
732
|
-
<span class="line"><span style="color:#E1E4E8">)</span></span>
|
|
733
|
-
<span class="line"></span></code></pre>
|
|
734
|
-
<h3 id="using-qr">Using qr()</h3>
|
|
735
|
-
<p>Generate QR codes as data URIs:</p>
|
|
736
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">qr</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">url</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
737
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full bg-white p-12'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
738
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#FFAB70">img</span></span>
|
|
739
|
-
<span class="line"><span style="color:#E1E4E8"> src</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">qr</span><span style="color:#E1E4E8">(</span><span style="color:#FFAB70">url</span><span style="color:#E1E4E8">, {</span></span>
|
|
740
|
-
<span class="line"><span style="color:#FFAB70"> width</span><span style="color:#E1E4E8">: </span><span style="color:#79B8FF">200</span><span style="color:#E1E4E8">,</span></span>
|
|
741
|
-
<span class="line"><span style="color:#FFAB70"> margin</span><span style="color:#E1E4E8">: </span><span style="color:#79B8FF">2</span><span style="color:#E1E4E8">,</span></span>
|
|
742
|
-
<span class="line"><span style="color:#FFAB70"> errorCorrectionLevel</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'M'</span><span style="color:#E1E4E8">,</span></span>
|
|
743
|
-
<span class="line"><span style="color:#FFAB70"> color</span><span style="color:#E1E4E8">: {</span></span>
|
|
744
|
-
<span class="line"><span style="color:#FFAB70"> dark</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#000000'</span><span style="color:#E1E4E8">,</span></span>
|
|
745
|
-
<span class="line"><span style="color:#FFAB70"> light</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'#ffffff'</span></span>
|
|
746
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
747
|
-
<span class="line"><span style="color:#E1E4E8"> })}</span></span>
|
|
748
|
-
<span class="line"><span style="color:#E1E4E8"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'w-48 h-48'</span><span style="color:#E1E4E8">)}</span></span>
|
|
749
|
-
<span class="line"><span style="color:#F97583"> /></span></span>
|
|
750
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
751
|
-
<span class="line"><span style="color:#E1E4E8">)</span></span>
|
|
752
|
-
<span class="line"></span></code></pre>
|
|
753
|
-
<p><strong>Options:</strong></p>
|
|
754
|
-
<ul>
|
|
755
|
-
<li><code>width</code> - QR code size in pixels (default: 200)</li>
|
|
756
|
-
<li><code>margin</code> - Quiet zone margin (default: 4)</li>
|
|
757
|
-
<li><code>errorCorrectionLevel</code> - <code>'L'</code>, <code>'M'</code>, <code>'Q'</code>, or <code>'H'</code> (default: ‘M’)</li>
|
|
758
|
-
<li><code>color.dark</code> - Dark module color (default: ‘#000000’)</li>
|
|
759
|
-
<li><code>color.light</code> - Light module color (default: ‘#ffffff’)</li>
|
|
760
|
-
</ul>
|
|
761
|
-
<h3 id="using-image">Using image()</h3>
|
|
762
|
-
<p>Embed local images as data URIs:</p>
|
|
763
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">image</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
764
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
765
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#6A737D">/* Image path relative to template directory */</span><span style="color:#E1E4E8">}</span></span>
|
|
766
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#FFAB70">img</span></span>
|
|
767
|
-
<span class="line"><span style="color:#E1E4E8"> src</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">image</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'logo.png'</span><span style="color:#E1E4E8">)}</span></span>
|
|
768
|
-
<span class="line"><span style="color:#E1E4E8"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'w-32 h-32'</span><span style="color:#E1E4E8">)}</span></span>
|
|
769
|
-
<span class="line"><span style="color:#F97583"> /></span></span>
|
|
770
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
771
|
-
<span class="line"><span style="color:#E1E4E8">)</span></span>
|
|
772
|
-
<span class="line"></span></code></pre>
|
|
773
|
-
<p><strong>Note:</strong> Images must be in the same directory as your template file when using <code>defineTemplateFromFile()</code>, or embedded as data URIs when using <code>defineTemplate()</code>.</p>
|
|
774
|
-
<h3 id="using-template">Using template()</h3>
|
|
775
|
-
<p>Compose templates by embedding one template inside another:</p>
|
|
776
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#6A737D">// Card template</span></span>
|
|
777
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> cardTemplate</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplate</span><span style="color:#E1E4E8">({</span></span>
|
|
778
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'card'</span><span style="color:#E1E4E8">,</span></span>
|
|
779
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">400</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">200</span><span style="color:#E1E4E8"> },</span></span>
|
|
780
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
781
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full bg-blue-500'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
782
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h2 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-2xl font-bold text-white'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">{title}</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">h2</span><span style="color:#F97583">></span></span>
|
|
783
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
784
|
-
<span class="line"><span style="color:#E1E4E8"> ),</span></span>
|
|
785
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
786
|
-
<span class="line"></span>
|
|
787
|
-
<span class="line"><span style="color:#6A737D">// Main template embedding the card</span></span>
|
|
788
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> mainTemplate</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplate</span><span style="color:#E1E4E8">({</span></span>
|
|
789
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'main'</span><span style="color:#E1E4E8">,</span></span>
|
|
790
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
791
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">template</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
792
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex flex-col gap-4 w-full h-full bg-gray-100 p-8'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
793
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-4xl font-bold'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">My Cards</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
794
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#6A737D">/* Embed card template */</span><span style="color:#E1E4E8">}</span></span>
|
|
795
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#FFAB70">img</span></span>
|
|
796
|
-
<span class="line"><span style="color:#E1E4E8"> src</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">template</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'card'</span><span style="color:#E1E4E8">, { </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'Card 1'</span><span style="color:#E1E4E8"> })}</span></span>
|
|
797
|
-
<span class="line"><span style="color:#E1E4E8"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'w-96'</span><span style="color:#E1E4E8">)}</span></span>
|
|
798
|
-
<span class="line"><span style="color:#F97583"> /></span></span>
|
|
799
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
800
|
-
<span class="line"><span style="color:#E1E4E8"> ),</span></span>
|
|
801
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
802
|
-
<span class="line"></span></code></pre>
|
|
803
|
-
<h3 id="video-animations">Video Animations</h3>
|
|
804
|
-
<p>Use Tailwind-style animation classes for easy video animations! All timing values are in <strong>milliseconds</strong>.</p>
|
|
805
|
-
<h4 id="enter-animations">Enter Animations</h4>
|
|
806
|
-
<p>Format: <code>enter-{type}/{startMs}/{endMs}</code> with optional easing</p>
|
|
807
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
808
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
809
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#6A737D">/* Fade in from 0ms to 1500ms */</span><span style="color:#E1E4E8">}</span></span>
|
|
810
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-8xl font-bold enter-fade-in/0/1500'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
811
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">}</span></span>
|
|
812
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
813
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
814
|
-
<span class="line"><span style="color:#E1E4E8">)</span></span>
|
|
815
|
-
<span class="line"></span></code></pre>
|
|
816
|
-
<p><strong>Available enter animations:</strong></p>
|
|
817
|
-
<p><em>Fade:</em></p>
|
|
818
|
-
<ul>
|
|
819
|
-
<li><code>enter-fade-in/0/500</code> - Fade in</li>
|
|
820
|
-
<li><code>enter-fade-in-up/0/500</code> - Fade in + slide up</li>
|
|
821
|
-
<li><code>enter-fade-in-down/0/500</code> - Fade in + slide down</li>
|
|
822
|
-
<li><code>enter-fade-in-left/0/500</code> - Fade in + slide from left</li>
|
|
823
|
-
<li><code>enter-fade-in-right/0/500</code> - Fade in + slide from right</li>
|
|
824
|
-
</ul>
|
|
825
|
-
<p><em>Slide:</em></p>
|
|
826
|
-
<ul>
|
|
827
|
-
<li><code>enter-slide-left/0/500</code> - Slide in from left (100px)</li>
|
|
828
|
-
<li><code>enter-slide-right/0/500</code> - Slide in from right (100px)</li>
|
|
829
|
-
<li><code>enter-slide-up/0/500</code> - Slide in from bottom (100px)</li>
|
|
830
|
-
<li><code>enter-slide-down/0/500</code> - Slide in from top (100px)</li>
|
|
831
|
-
</ul>
|
|
832
|
-
<p><em>Bounce:</em></p>
|
|
833
|
-
<ul>
|
|
834
|
-
<li><code>enter-bounce-in/0/500</code> - Bounce in with scale overshoot</li>
|
|
835
|
-
<li><code>enter-bounce-in-up/0/500</code> - Bounce in from below</li>
|
|
836
|
-
<li><code>enter-bounce-in-down/0/500</code> - Bounce in from above</li>
|
|
837
|
-
<li><code>enter-bounce-in-left/0/500</code> - Bounce in from left</li>
|
|
838
|
-
<li><code>enter-bounce-in-right/0/500</code> - Bounce in from right</li>
|
|
839
|
-
</ul>
|
|
840
|
-
<p><em>Scale & Zoom:</em></p>
|
|
841
|
-
<ul>
|
|
842
|
-
<li><code>enter-scale-in/0/500</code> - Scale up from 50%</li>
|
|
843
|
-
<li><code>enter-zoom-in/0/500</code> - Zoom in from 0%</li>
|
|
844
|
-
</ul>
|
|
845
|
-
<p><em>Rotate & Flip:</em></p>
|
|
846
|
-
<ul>
|
|
847
|
-
<li><code>enter-rotate-in/0/500</code> - Rotate in (180°)</li>
|
|
848
|
-
<li><code>enter-flip-in-x/0/500</code> - Flip in horizontally</li>
|
|
849
|
-
<li><code>enter-flip-in-y/0/500</code> - Flip in vertically</li>
|
|
850
|
-
</ul>
|
|
851
|
-
<h4 id="exit-animations">Exit Animations</h4>
|
|
852
|
-
<p>Format: <code>exit-{type}/{startMs}/{endMs}</code></p>
|
|
853
|
-
<ul>
|
|
854
|
-
<li><code>exit-fade-out/2500/3000</code> - Fade out</li>
|
|
855
|
-
<li><code>exit-fade-out-up/2500/3000</code> - Fade out + slide up</li>
|
|
856
|
-
<li><code>exit-slide-left/2500/3000</code> - Slide out to left</li>
|
|
857
|
-
<li><code>exit-scale-out/2500/3000</code> - Scale out to 150%</li>
|
|
858
|
-
<li><code>exit-zoom-out/2500/3000</code> - Zoom out to 200%</li>
|
|
859
|
-
</ul>
|
|
860
|
-
<p><strong>Easing modifiers:</strong></p>
|
|
861
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#6A737D">// Add easing before animation class</span></span>
|
|
862
|
-
<span class="line"><span style="color:#F97583"><</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'ease-in-out enter-fade-in/0/1500'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
863
|
-
<span class="line"></span></code></pre>
|
|
864
|
-
<ul>
|
|
865
|
-
<li><code>linear</code> - Linear</li>
|
|
866
|
-
<li><code>ease-in</code> - Accelerate</li>
|
|
867
|
-
<li><code>ease-out</code> - Decelerate (default)</li>
|
|
868
|
-
<li><code>ease-in-out</code> - Accelerate then decelerate</li>
|
|
869
|
-
<li><code>ease-in-cubic</code> - Strong accelerate</li>
|
|
870
|
-
<li><code>ease-out-cubic</code> - Strong decelerate</li>
|
|
871
|
-
<li><code>ease-in-out-cubic</code> - Strong ease in/out</li>
|
|
872
|
-
</ul>
|
|
873
|
-
<h4 id="loop-animations">Loop Animations</h4>
|
|
874
|
-
<p>Format: <code>loop-{type}/{durationMs}</code></p>
|
|
875
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
876
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
877
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#6A737D">/* Pulse every 500ms */</span><span style="color:#E1E4E8">}</span></span>
|
|
878
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-8xl font-bold loop-fade/500'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
879
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">}</span></span>
|
|
880
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
881
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
882
|
-
<span class="line"><span style="color:#E1E4E8">)</span></span>
|
|
883
|
-
<span class="line"></span></code></pre>
|
|
884
|
-
<p><strong>Available loop animations:</strong></p>
|
|
885
|
-
<ul>
|
|
886
|
-
<li><code>loop-fade/1000</code> - Opacity pulse</li>
|
|
887
|
-
<li><code>loop-bounce/1000</code> - Bounce up and down</li>
|
|
888
|
-
<li><code>loop-spin/1000</code> - Full rotation</li>
|
|
889
|
-
<li><code>loop-ping/1000</code> - Scale up and fade out</li>
|
|
890
|
-
<li><code>loop-wiggle/1000</code> - Side to side wiggle</li>
|
|
891
|
-
<li><code>loop-float/1000</code> - Gentle floating</li>
|
|
892
|
-
</ul>
|
|
893
|
-
<h4 id="staggered-animations">Staggered Animations</h4>
|
|
894
|
-
<p>Combine multiple animations with different timings:</p>
|
|
895
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">subtitle</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
896
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex flex-col items-center justify-center w-full h-full'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
897
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#6A737D">/* Title slides in first */</span><span style="color:#E1E4E8">}</span></span>
|
|
898
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-8xl font-bold ease-out enter-slide-up/0/900'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
899
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">}</span></span>
|
|
900
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
901
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#6A737D">/* Subtitle slides in after */</span><span style="color:#E1E4E8">}</span></span>
|
|
902
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">p style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-2xl mt-4 ease-out enter-slide-up/600/1500'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
903
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#FFAB70">subtitle</span><span style="color:#E1E4E8">}</span></span>
|
|
904
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">p</span><span style="color:#F97583">></span></span>
|
|
905
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
906
|
-
<span class="line"><span style="color:#E1E4E8">)</span></span>
|
|
907
|
-
<span class="line"></span></code></pre>
|
|
908
|
-
<h4 id="combined-enter-and-exit">Combined Enter and Exit</h4>
|
|
909
|
-
<p>You can use both on the same element:</p>
|
|
910
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
911
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-8xl font-bold enter-fade-in/0/500 exit-fade-out/2500/3000'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
912
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">}</span></span>
|
|
913
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
914
|
-
<span class="line"><span style="color:#E1E4E8">)</span></span>
|
|
915
|
-
<span class="line"></span></code></pre>
|
|
916
|
-
<h4 id="manual-animations">Manual Animations</h4>
|
|
917
|
-
<p>You can still use <code>progress</code> and <code>frame</code> directly for custom animations:</p>
|
|
918
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#B392F0">render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">progress</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">frame</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> {</span></span>
|
|
919
|
-
<span class="line"><span style="color:#6A737D"> // Custom easing</span></span>
|
|
920
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#79B8FF"> opacity</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> Math.</span><span style="color:#B392F0">pow</span><span style="color:#E1E4E8">(progress, </span><span style="color:#79B8FF">2</span><span style="color:#E1E4E8">);</span></span>
|
|
921
|
-
<span class="line"></span>
|
|
922
|
-
<span class="line"><span style="color:#6A737D"> // Custom transform</span></span>
|
|
923
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#79B8FF"> rotation</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> Math.</span><span style="color:#B392F0">sin</span><span style="color:#E1E4E8">(frame </span><span style="color:#F97583">*</span><span style="color:#79B8FF"> 0.1</span><span style="color:#E1E4E8">) </span><span style="color:#F97583">*</span><span style="color:#79B8FF"> 10</span><span style="color:#E1E4E8">;</span></span>
|
|
924
|
-
<span class="line"></span>
|
|
925
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> (</span></span>
|
|
926
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex items-center justify-center w-full h-full'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
927
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{{</span></span>
|
|
928
|
-
<span class="line"><span style="color:#F97583"> ...</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-8xl font-bold'</span><span style="color:#E1E4E8">),</span></span>
|
|
929
|
-
<span class="line"><span style="color:#E1E4E8"> opacity,</span></span>
|
|
930
|
-
<span class="line"><span style="color:#B392F0"> transform</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">`rotate(${</span><span style="color:#E1E4E8">rotation</span><span style="color:#9ECBFF">}deg)`</span></span>
|
|
931
|
-
<span class="line"><span style="color:#E1E4E8"> }}</span><span style="color:#F97583">></span></span>
|
|
932
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">}</span></span>
|
|
933
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
934
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
935
|
-
<span class="line"><span style="color:#E1E4E8"> );</span></span>
|
|
936
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
937
|
-
<span class="line"></span></code></pre>
|
|
938
|
-
<h2 id="template-registry">Template Registry</h2>
|
|
939
|
-
<p>Create a registry of reusable templates:</p>
|
|
940
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#6A737D">// lib/templates.ts</span></span>
|
|
941
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplate } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
942
|
-
<span class="line"></span>
|
|
943
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> const</span><span style="color:#79B8FF"> templates</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> {</span></span>
|
|
944
|
-
<span class="line"><span style="color:#E1E4E8"> ogImage: </span><span style="color:#B392F0">defineTemplate</span><span style="color:#E1E4E8">({</span></span>
|
|
945
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'og-image'</span><span style="color:#E1E4E8">,</span></span>
|
|
946
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
947
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span><span style="color:#6A737D">/* ... */</span><span style="color:#E1E4E8">),</span></span>
|
|
948
|
-
<span class="line"><span style="color:#E1E4E8"> }),</span></span>
|
|
949
|
-
<span class="line"></span>
|
|
950
|
-
<span class="line"><span style="color:#E1E4E8"> twitterCard: </span><span style="color:#B392F0">defineTemplate</span><span style="color:#E1E4E8">({</span></span>
|
|
951
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'twitter-card'</span><span style="color:#E1E4E8">,</span></span>
|
|
952
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">600</span><span style="color:#E1E4E8"> },</span></span>
|
|
953
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">author</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span><span style="color:#6A737D">/* ... */</span><span style="color:#E1E4E8">),</span></span>
|
|
954
|
-
<span class="line"><span style="color:#E1E4E8"> }),</span></span>
|
|
955
|
-
<span class="line"></span>
|
|
956
|
-
<span class="line"><span style="color:#E1E4E8"> videoIntro: </span><span style="color:#B392F0">defineTemplate</span><span style="color:#E1E4E8">({</span></span>
|
|
957
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'video-intro'</span><span style="color:#E1E4E8">,</span></span>
|
|
958
|
-
<span class="line"><span style="color:#E1E4E8"> type: </span><span style="color:#9ECBFF">'video'</span><span style="color:#E1E4E8">,</span></span>
|
|
959
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1920</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">1080</span><span style="color:#E1E4E8"> },</span></span>
|
|
960
|
-
<span class="line"><span style="color:#E1E4E8"> video: { fps: </span><span style="color:#79B8FF">30</span><span style="color:#E1E4E8">, duration: </span><span style="color:#79B8FF">3</span><span style="color:#E1E4E8"> },</span></span>
|
|
961
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">progress</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span><span style="color:#6A737D">/* ... */</span><span style="color:#E1E4E8">),</span></span>
|
|
962
|
-
<span class="line"><span style="color:#E1E4E8"> }),</span></span>
|
|
963
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
964
|
-
<span class="line"></span>
|
|
965
|
-
<span class="line"><span style="color:#6A737D">// pages/api/render/[template].ts</span></span>
|
|
966
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { templates } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> '@/lib/templates'</span><span style="color:#E1E4E8">;</span></span>
|
|
967
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { renderImage, renderVideo } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
968
|
-
<span class="line"></span>
|
|
969
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> default</span><span style="color:#F97583"> async</span><span style="color:#F97583"> function</span><span style="color:#B392F0"> handler</span><span style="color:#E1E4E8">(</span><span style="color:#FFAB70">req</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">res</span><span style="color:#E1E4E8">) {</span></span>
|
|
970
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#E1E4E8"> { </span><span style="color:#FFAB70">template</span><span style="color:#E1E4E8">: </span><span style="color:#79B8FF">templateName</span><span style="color:#E1E4E8"> } </span><span style="color:#F97583">=</span><span style="color:#E1E4E8"> req.query;</span></span>
|
|
971
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#79B8FF"> template</span><span style="color:#F97583"> =</span><span style="color:#E1E4E8"> templates[templateName];</span></span>
|
|
972
|
-
<span class="line"></span>
|
|
973
|
-
<span class="line"><span style="color:#F97583"> if</span><span style="color:#E1E4E8"> (</span><span style="color:#F97583">!</span><span style="color:#E1E4E8">template) {</span></span>
|
|
974
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">status</span><span style="color:#E1E4E8">(</span><span style="color:#79B8FF">404</span><span style="color:#E1E4E8">).</span><span style="color:#B392F0">json</span><span style="color:#E1E4E8">({ error: </span><span style="color:#9ECBFF">'Template not found'</span><span style="color:#E1E4E8"> });</span></span>
|
|
975
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
976
|
-
<span class="line"></span>
|
|
977
|
-
<span class="line"><span style="color:#F97583"> if</span><span style="color:#E1E4E8"> (template.type </span><span style="color:#F97583">===</span><span style="color:#9ECBFF"> 'video'</span><span style="color:#E1E4E8">) {</span></span>
|
|
978
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#79B8FF"> mp4</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderVideo</span><span style="color:#E1E4E8">(template, req.query);</span></span>
|
|
979
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">setHeader</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'Content-Type'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'video/mp4'</span><span style="color:#E1E4E8">);</span></span>
|
|
980
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">send</span><span style="color:#E1E4E8">(mp4);</span></span>
|
|
981
|
-
<span class="line"><span style="color:#E1E4E8"> } </span><span style="color:#F97583">else</span><span style="color:#E1E4E8"> {</span></span>
|
|
982
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#79B8FF"> png</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template, req.query);</span></span>
|
|
983
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">setHeader</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'Content-Type'</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">'image/png'</span><span style="color:#E1E4E8">);</span></span>
|
|
984
|
-
<span class="line"><span style="color:#E1E4E8"> res.</span><span style="color:#B392F0">send</span><span style="color:#E1E4E8">(png);</span></span>
|
|
985
|
-
<span class="line"><span style="color:#E1E4E8"> }</span></span>
|
|
986
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
987
|
-
<span class="line"></span></code></pre>
|
|
988
|
-
<h2 id="typescript-support">TypeScript Support</h2>
|
|
989
|
-
<p>Define typed props for your templates:</p>
|
|
990
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#F97583">interface</span><span style="color:#B392F0"> OGImageProps</span><span style="color:#E1E4E8"> {</span></span>
|
|
991
|
-
<span class="line"><span style="color:#FFAB70"> title</span><span style="color:#F97583">:</span><span style="color:#79B8FF"> string</span><span style="color:#E1E4E8">;</span></span>
|
|
992
|
-
<span class="line"><span style="color:#FFAB70"> description</span><span style="color:#F97583">:</span><span style="color:#79B8FF"> string</span><span style="color:#E1E4E8">;</span></span>
|
|
993
|
-
<span class="line"><span style="color:#FFAB70"> author</span><span style="color:#F97583">?:</span><span style="color:#79B8FF"> string</span><span style="color:#E1E4E8">;</span></span>
|
|
994
|
-
<span class="line"><span style="color:#E1E4E8">}</span></span>
|
|
995
|
-
<span class="line"></span>
|
|
996
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> ogTemplate</span><span style="color:#F97583"> =</span><span style="color:#B392F0"> defineTemplate</span><span style="color:#E1E4E8"><</span><span style="color:#B392F0">OGImageProps</span><span style="color:#E1E4E8">>({</span></span>
|
|
997
|
-
<span class="line"><span style="color:#E1E4E8"> name: </span><span style="color:#9ECBFF">'og-image'</span><span style="color:#E1E4E8">,</span></span>
|
|
998
|
-
<span class="line"><span style="color:#E1E4E8"> size: { width: </span><span style="color:#79B8FF">1200</span><span style="color:#E1E4E8">, height: </span><span style="color:#79B8FF">630</span><span style="color:#E1E4E8"> },</span></span>
|
|
999
|
-
<span class="line"><span style="color:#B392F0"> render</span><span style="color:#E1E4E8">: ({ </span><span style="color:#FFAB70">tw</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">title</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">description</span><span style="color:#E1E4E8">, </span><span style="color:#FFAB70">author</span><span style="color:#E1E4E8"> }) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> (</span></span>
|
|
1000
|
-
<span class="line"><span style="color:#6A737D"> // Props are fully typed!</span></span>
|
|
1001
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">div style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'flex flex-col w-full h-full'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span></span>
|
|
1002
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">h1 style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-6xl font-bold'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">{title}</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">h1</span><span style="color:#F97583">></span></span>
|
|
1003
|
-
<span class="line"><span style="color:#F97583"> <</span><span style="color:#E1E4E8">p style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-2xl'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">{description}</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">p</span><span style="color:#F97583">></span></span>
|
|
1004
|
-
<span class="line"><span style="color:#E1E4E8"> {</span><span style="color:#FFAB70">author</span><span style="color:#E1E4E8"> && <</span><span style="color:#FFAB70">span</span><span style="color:#FFAB70"> style</span><span style="color:#F97583">=</span><span style="color:#E1E4E8">{</span><span style="color:#B392F0">tw</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'text-xl'</span><span style="color:#E1E4E8">)}</span><span style="color:#F97583">></span><span style="color:#E1E4E8">By {author}</span><span style="color:#F97583"></</span><span style="color:#E1E4E8">span</span><span style="color:#F97583">></span><span style="color:#E1E4E8">}</span></span>
|
|
1005
|
-
<span class="line"><span style="color:#F97583"> </</span><span style="color:#E1E4E8">div</span><span style="color:#F97583">></span></span>
|
|
1006
|
-
<span class="line"><span style="color:#E1E4E8"> ),</span></span>
|
|
1007
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
1008
|
-
<span class="line"></span>
|
|
1009
|
-
<span class="line"><span style="color:#6A737D">// TypeScript will enforce correct props</span></span>
|
|
1010
|
-
<span class="line"><span style="color:#F97583">const</span><span style="color:#79B8FF"> png</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(ogTemplate, {</span></span>
|
|
1011
|
-
<span class="line"><span style="color:#E1E4E8"> title: </span><span style="color:#9ECBFF">'Hello'</span><span style="color:#E1E4E8">,</span></span>
|
|
1012
|
-
<span class="line"><span style="color:#E1E4E8"> description: </span><span style="color:#9ECBFF">'World'</span><span style="color:#E1E4E8">,</span></span>
|
|
1013
|
-
<span class="line"><span style="color:#6A737D"> // author is optional</span></span>
|
|
1014
|
-
<span class="line"><span style="color:#E1E4E8">});</span></span>
|
|
1015
|
-
<span class="line"></span></code></pre>
|
|
1016
|
-
<h2 id="deployment">Deployment</h2>
|
|
1017
|
-
<h3 id="vercel">Vercel</h3>
|
|
1018
|
-
<p>The SDK works out of the box on Vercel serverless functions:</p>
|
|
1019
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#B392F0">npm</span><span style="color:#9ECBFF"> install</span><span style="color:#9ECBFF"> loopwind</span></span>
|
|
1020
|
-
<span class="line"><span style="color:#B392F0">vercel</span><span style="color:#9ECBFF"> deploy</span></span>
|
|
1021
|
-
<span class="line"></span></code></pre>
|
|
1022
|
-
<h3 id="netlify">Netlify</h3>
|
|
1023
|
-
<p>Works with Netlify Functions:</p>
|
|
1024
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="typescript"><code><span class="line"><span style="color:#6A737D">// netlify/functions/og-image.ts</span></span>
|
|
1025
|
-
<span class="line"><span style="color:#F97583">import</span><span style="color:#E1E4E8"> { defineTemplate, renderImage } </span><span style="color:#F97583">from</span><span style="color:#9ECBFF"> 'loopwind/sdk'</span><span style="color:#E1E4E8">;</span></span>
|
|
1026
|
-
<span class="line"></span>
|
|
1027
|
-
<span class="line"><span style="color:#F97583">export</span><span style="color:#F97583"> const</span><span style="color:#B392F0"> handler</span><span style="color:#F97583"> =</span><span style="color:#F97583"> async</span><span style="color:#E1E4E8"> (</span><span style="color:#FFAB70">event</span><span style="color:#E1E4E8">) </span><span style="color:#F97583">=></span><span style="color:#E1E4E8"> {</span></span>
|
|
1028
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#E1E4E8"> { </span><span style="color:#79B8FF">title</span><span style="color:#E1E4E8"> } </span><span style="color:#F97583">=</span><span style="color:#E1E4E8"> event.queryStringParameters </span><span style="color:#F97583">||</span><span style="color:#E1E4E8"> {};</span></span>
|
|
1029
|
-
<span class="line"></span>
|
|
1030
|
-
<span class="line"><span style="color:#F97583"> const</span><span style="color:#79B8FF"> png</span><span style="color:#F97583"> =</span><span style="color:#F97583"> await</span><span style="color:#B392F0"> renderImage</span><span style="color:#E1E4E8">(template, { title });</span></span>
|
|
1031
|
-
<span class="line"></span>
|
|
1032
|
-
<span class="line"><span style="color:#F97583"> return</span><span style="color:#E1E4E8"> {</span></span>
|
|
1033
|
-
<span class="line"><span style="color:#E1E4E8"> statusCode: </span><span style="color:#79B8FF">200</span><span style="color:#E1E4E8">,</span></span>
|
|
1034
|
-
<span class="line"><span style="color:#E1E4E8"> headers: { </span><span style="color:#9ECBFF">'Content-Type'</span><span style="color:#E1E4E8">: </span><span style="color:#9ECBFF">'image/png'</span><span style="color:#E1E4E8"> },</span></span>
|
|
1035
|
-
<span class="line"><span style="color:#E1E4E8"> body: png.</span><span style="color:#B392F0">toString</span><span style="color:#E1E4E8">(</span><span style="color:#9ECBFF">'base64'</span><span style="color:#E1E4E8">),</span></span>
|
|
1036
|
-
<span class="line"><span style="color:#E1E4E8"> isBase64Encoded: </span><span style="color:#79B8FF">true</span><span style="color:#E1E4E8">,</span></span>
|
|
1037
|
-
<span class="line"><span style="color:#E1E4E8"> };</span></span>
|
|
1038
|
-
<span class="line"><span style="color:#E1E4E8">};</span></span>
|
|
1039
|
-
<span class="line"></span></code></pre>
|
|
1040
|
-
<h3 id="docker">Docker</h3>
|
|
1041
|
-
<p>For self-hosted deployments:</p>
|
|
1042
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="dockerfile"><code><span class="line"><span style="color:#F97583">FROM</span><span style="color:#E1E4E8"> node:20-alpine</span></span>
|
|
1043
|
-
<span class="line"><span style="color:#F97583">WORKDIR</span><span style="color:#E1E4E8"> /app</span></span>
|
|
1044
|
-
<span class="line"><span style="color:#F97583">COPY</span><span style="color:#E1E4E8"> package*.json ./</span></span>
|
|
1045
|
-
<span class="line"><span style="color:#F97583">RUN</span><span style="color:#E1E4E8"> npm install</span></span>
|
|
1046
|
-
<span class="line"><span style="color:#F97583">COPY</span><span style="color:#E1E4E8"> . .</span></span>
|
|
1047
|
-
<span class="line"><span style="color:#F97583">RUN</span><span style="color:#E1E4E8"> npm run build</span></span>
|
|
1048
|
-
<span class="line"><span style="color:#F97583">CMD</span><span style="color:#E1E4E8"> [</span><span style="color:#9ECBFF">"npm"</span><span style="color:#E1E4E8">, </span><span style="color:#9ECBFF">"start"</span><span style="color:#E1E4E8">]</span></span>
|
|
1049
|
-
<span class="line"></span></code></pre>
|
|
1050
|
-
<h2 id="performance">Performance</h2>
|
|
1051
|
-
<ul>
|
|
1052
|
-
<li><strong>Images</strong>: ~50-100ms per image (PNG/JPEG/WebP)</li>
|
|
1053
|
-
<li><strong>Videos</strong>: ~7s for 3-second Full HD video (1920×1080 @ 30fps)</li>
|
|
1054
|
-
<li><strong>Pure JavaScript/WASM</strong>: No native dependencies, works everywhere</li>
|
|
1055
|
-
</ul>
|
|
1056
|
-
<h2 id="use-cases">Use Cases</h2>
|
|
1057
|
-
<ul>
|
|
1058
|
-
<li><strong>Dynamic OG images</strong> for blogs and marketing sites</li>
|
|
1059
|
-
<li><strong>Programmatic videos</strong> for social media automation</li>
|
|
1060
|
-
<li><strong>Email images</strong> generated on-the-fly</li>
|
|
1061
|
-
<li><strong>User-generated content</strong> like certificates, cards, badges</li>
|
|
1062
|
-
<li><strong>Batch processing</strong> of images or videos</li>
|
|
1063
|
-
<li><strong>Image/video generation APIs</strong> that you can monetize</li>
|
|
1064
|
-
</ul>
|
|
1065
|
-
<h2 id="example-project">Example Project</h2>
|
|
1066
|
-
<p>See the full Next.js example at <a href="https://github.com/tomtev/loopwind/tree/main/examples/nextjs-api">examples/nextjs-api/</a></p>
|
|
1067
|
-
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8;overflow-x:auto" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#B392F0">git</span><span style="color:#9ECBFF"> clone</span><span style="color:#9ECBFF"> https://github.com/tomtev/loopwind.git</span></span>
|
|
1068
|
-
<span class="line"><span style="color:#79B8FF">cd</span><span style="color:#9ECBFF"> loopwind/examples/nextjs-api</span></span>
|
|
1069
|
-
<span class="line"><span style="color:#B392F0">npm</span><span style="color:#9ECBFF"> install</span></span>
|
|
1070
|
-
<span class="line"><span style="color:#B392F0">npm</span><span style="color:#9ECBFF"> run</span><span style="color:#9ECBFF"> dev</span></span>
|
|
1071
|
-
<span class="line"></span></code></pre>
|
|
1072
|
-
<p>Then visit:</p>
|
|
1073
|
-
<ul>
|
|
1074
|
-
<li><code>http://localhost:3000/api/og-image?title=Hello</code></li>
|
|
1075
|
-
<li><code>http://localhost:3000/api/intro-video?title=Welcome</code></li>
|
|
1076
|
-
</ul> </article> </div> </main> <!-- Table of Contents Sidebar (Desktop only) --> <aside id="toc-sidebar" class="toc-sidebar fixed top-0 right-0 h-screen w-64 overflow-y-auto z-10" data-astro-cid-mw7aashj> <div class="px-6 py-8" data-astro-cid-mw7aashj> <h3 class="text-xs font-semibold text-muted-foreground mb-4 uppercase tracking-wider" data-astro-cid-mw7aashj>On this page</h3> <nav id="toc-nav" data-astro-cid-mw7aashj> <!-- TOC will be populated by JavaScript --> </nav> </div> </aside> </div> </body></html>
|