https://github.com/desdaemon/typed-htmx

Definitions for htmx attributes
https://github.com/desdaemon/typed-htmx

html htmx jsx templating-engine typesafe typescript

Last synced: 6 days ago
JSON representation

Definitions for htmx attributes

• Host: GitHub
• URL: https://github.com/desdaemon/typed-htmx
• Owner: Desdaemon
• License: isc
• Created: 2023-07-22T17:23:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-14T17:18:07.000Z (7 months ago)
• Last Synced: 2024-12-12T08:25:51.358Z (13 days ago)
• Topics: html, htmx, jsx, templating-engine, typesafe, typescript
• Language: TypeScript
• Homepage: https://desdaemon.github.io/typed-htmx/
• Size: 1.02 MB
• Stars: 107
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# typed-htmx

[![npm](https://img.shields.io/npm/v/typed-htmx?style=flat-square)](https://www.npmjs.com/package/typed-htmx)

[![docs](https://github.com/Desdaemon/typed-htmx/actions/workflows/docs.yml/badge.svg)](https://github.com/Desdaemon/typed-htmx/actions/workflows/docs.yml)

[![tests](https://github.com/Desdaemon/typed-htmx/actions/workflows/test.yml/badge.svg)](https://github.com/Desdaemon/typed-htmx/actions/workflows/test.yml)

[![demo](static/demo.gif)](https://asciinema.org/a/598553)

Definitions for htmx attributes in JSX.

## Usage

You can configure `typed-htmx` either as pure type declarations, or as a JSX

templating engine.

### As type declarations

Configure your `tsconfig.json` as follows:

```jsonc

{

  "compilerOptions": {

    "jsx": "react",

    "moduleResolution": "node16", // or "nodenext"

    "types": ["typed-htmx" /** and any other types you need */]

  }

}

```

An alternative is to include a _[triple-slash directive]_ wherever you need

completions for htmx attributes:

```jsx

/// 

function MyComponent({ children }) {

  return 
{children}
;

  //          ^?: string | undefined

}

```


If your frontend library injects its own JSX types, you'll need to augment it.

See the [example project](https://github.com/Desdaemon/typed-htmx/tree/main/example)

for a demo. typed-html and React are supported out of the box.

### As a JSX templating engine

If you prefer to use JSX only for its templating capabilities in the vein of

[typed-html], you can use `typed-htmx/typed-html` which is included with this

library and optimized for htmx usage:

- Attributes such as [`hx-vals`](https://htmx.org/attributes/hx-vals/) and

  [`hx-headers`](https://htmx.org/attributes/hx-headers/) may also accept an object

  literal, which will be stringified on demand.

- Configurable options for sanitization, defaults to a no-op.

Configure your `tsconfig.json` as follows:

```jsonc

{

  "compilerOptions": {

    "jsx": "react-jsx",

    "jsxImportSource": "typed-htmx/typed-html",

    "moduleResolution": "node16" // or "nodenext"

  }

}

```

[typed-html]: https://github.com/nicojs/typed-html

[triple-slash directive]: https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html