ex_unpoly

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 11 Open GitHub ↗

Plug adapter for Unpoly, the unobtrusive JavaScript framework

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ex_unpoly

[![Build Status](https://img.shields.io/github/actions/workflow/status/webstronauts/ex_unpoly/test.yml?branch=main&style=flat-square)](https://github.com/webstronauts/ex_unpoly/actions?query=workflow%3Atest)
[![Hex.pm](https://img.shields.io/hexpm/v/unpoly.svg?style=flat-square)](https://hex.pm/packages/unpoly)
[![Hexdocs.pm](https://img.shields.io/badge/hex-docs-blue.svg?style=flat-square)](https://hexdocs.pm/unpoly/)

A Plug adapter and helpers for Unpoly, the unobtrusive JavaScript framework.

---

<img src="https://webstronauts.com/images/logo-circle.svg?foo=bar" height="16" alt="" /> Built by
 <a href="https://webstronauts.com/?utm_source=ex_unpoly&utm_campaign=readme-button&utm_medium=github">The Webstronauts</a>, go-to agency for challenging ideas and ambitious organisations.

---

## Installation

To use Unpoly, you can add it to your application's dependencies.

```elixir
def deps do
  [
    {:unpoly, "~> 3.0"}
  ]
end
```

## Usage

You can use the plug within your pipeline.

```elixir
defmodule MyApp.Endpoint do
  plug Logger
  plug Unpoly
  plug MyApp.Router
end
```

### Phoenix Components

If you're using Phoenix Components (HEEx templates), you'll need to configure the global attribute prefixes to allow `up-` attributes on HTML elements. Add the following to your `lib/my_app_web.ex` file:

```elixir
def html do
  quote do
    use Phoenix.Component, global_prefixes: ~w(up-)
    # ... rest of your configuration
  end
end
```

This tells Phoenix.Component to accept attributes with the `up-` prefix (like `up-target`, `up-layer`, etc.) in your function components. See the [Phoenix.Component documentation](https://hexdocs.pm/phoenix_live_view/Phoenix.Component.html#module-custom-global-attribute-prefixes) for more details.

---

To find out more, head to the [online documentation]([https://hexdocs.pm/ex_unpoly).

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Clone the repository and run `mix test`. To generate docs, run `mix docs`.

## Credits

As it's just a simple port of Ruby to Elixir. All credits should go to the Unpoly team and their [unpoly](https://github.com/unpoly/unpoly) library.

- [Robin van der Vleuten](https://github.com/robinvdvleuten)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.

ex_unpoly

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README