classnames

KO | EN

gitlite — search

#javascript #python #ai #llm #go #golang #rust #docker #windows #awesome #vue #mcp #openai #open-source

(★ 8)

A simple utility for conditionally joining class names in Elixir

classnames Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Classnames

A simple utility for conditionally joining class names together.

## Installation

The package can be installed as:

```elixir
def deps do
  [{:classnames, "~> 0.1.0"}]
end
```

## Usage

This module only has one public function: `Classnames.classnames/1`. Here are a few examples:

```elixir
classnames([:one])                       #=> "one"
classnames(["one"])                      #=> "one"
classnames([:one, :two])                 #=> "one two"
classnames([active: 1 == 1])             #=> "active"
classnames([active: 1 == 2])             #=> ""
classnames([:one, :two, active: 1 == 1]) #=> "one two active"
classnames([:one, :two, active: 1 == 2]) #=> "one two"
classnames([{:active, 1 == 1}])          #=> "active"
classnames([{:active, 1 == 2}])          #=> ""
classnames([:one, {:active, 1 == 1}])    #=> "one active"
classnames([:one, {:active, 1 == 2}])    #=> "one"
```

## Phoenix

If you want classnames to be accessible in your Phoenix templates:

```elixir
defmodule MyApp.Web do
  def view do
    quote do
      # ...
      use Classnames
      # ...
    end
  end
end
```

## Alternatives

If you are using the new(er) Heex template files, this dependency may not be necessary, as the `class` attribute in `Phoenix.HTML.Form` elements also accepts a list (of strings/atoms) and already filters values that are `nil` or `false`. So with that in mind instead of

```elixir
class = classnames([
  "foo": 1 + 1 == 2,
  bar: 1 == 0
])
```
You can just as easily reverse the condition/class name and write

```elixir
class = [
  1 + 1 == 2 and "foo",
  1 == 0 and :bar
]
```

classnames

classnames Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

classnames

classnames Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README