Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 4.51 KB

README.md

File metadata and controls

73 lines (57 loc) · 4.51 KB
Raw

Go Reference

Tailush

Tailush is a library with form plush helpers for TailwindCSS forms and inputs. Its a drop in replacement for the form and form_for helpers that ship with Buffalo and are oriented towards Bootstrap. The goal of this library is to accelerate the development of web applications by make it simpler to develop forms with TailwindCSS in plush.

Installation

go get github.com/wawandco/tailush@latest

Usage

To install Tailush you should replace the form and form_for helpers in your actions/helpers.go file.

// In your helpers.go
import (
    ...
    "tailush"
    ...
)

... 
    // Custom Tailwindcss form helpers
    "formFor": tailush.FormForFn(),
    "form":    tailush.FormFn(),
...

Customizing

Customizing the form helpers is done by passing different instances of tailush.Option to the FormFn and FormForFn functions. The following example shows a set of options that can be passed to the helpers.

... 
    // Custom Tailwindcss form helpers
    "formFor": tailush.FormForFn(
        tailush.UseFieldContainerClass("mb-4"),
        tailush.UseLabelClass("block text-gray-700 text-sm font-bold mb-2"),
        tailush.UseInputClass("shadow border rounded-md w-full p-2 text-gray-700 focus:outline-none focus:shadow-outline"),
        tailush.UseErrorClass("text-red-500 text-xs italic"),
    ),
    ...
...

Customizing options

The following options are available for the form helpers:

Option ⚙️ Component ⚒️ Default classes ✏️
tailush.UseLabelClass() <%= f.Label() %> block text-sm font-medium text-gray-700
tailush.UseInputClass() <%= f.InputTag() %> border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700
tailush.UseCheckboxClass() <%= f.CheckboxTag() %> TBD
tailush.UseRadioClass() <%= f.RadioButtonTag() %> TBD
tailush.UseFileClass() <%= f.FileTag() %> TBD
tailush.UseTextAreaClass() <%= f.TextAreaTag() %> border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full
tailush.UseSelectClass() <%= f.SelectTag() %> border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full py-2 mt-1 text-base sm:text-sm
tailush.UseDateInputClass() <%= f.DateTimeTag() %> border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700
tailush.UseFieldContainerClass() Not implemented yet TBD
tailush.UseErrorClass() Not implemented yet TBD