Formtastic

https://rubydoc.info/github/formtastic/formtastic/master
Admin
Formtastic is a Ruby form builder for Rails that generates semantic HTML forms with support for...
Tokens:154,025
Snippets:1,236
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Run Formtastic Installation

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/InstallGenerator

Command to generate the Formtastic configuration initializer.

```shell
$ rails generate formtastic:install
```

--------------------------------

### Formtastic LinkAction Configuration

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Actions/LinkAction

Examples of how to configure the LinkAction component using the f.action helper.

```APIDOC
## LinkAction Configuration

### Description
Configures a link action within a Formtastic form using the `f.action` helper with `:as => :link`.

### Parameters
- **url** (String/Hash/Symbol) - Optional - The URL for the link. Defaults to :back.
- **label** (String) - Optional - The text label for the link.
- **button_html** (Hash) - Optional - HTML attributes applied to the <a> tag.
- **wrapper_html** (Hash) - Optional - HTML attributes applied to the <li> wrapper.
- **accesskey** (String) - Optional - Access key for the link.

### Request Example
<%= f.action :cancel, :as => :link, :url => "/path", :label => "Stop", :button_html => { :class => 'pretty' } %>
```

--------------------------------

### GET #to_html

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/TextInput

Renders the full HTML structure for the text input, including the wrapper and label.

```APIDOC
## GET #to_html

### Description
Generates the complete HTML output for the text input field, wrapping the label and the text area element.

### Response
- **String** - The rendered HTML string for the input component.
```

--------------------------------

### Configuring Country Input

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/CountryInput

Examples of how to use the :country input type with the :priority_countries option for different versions of the country_select plugin.

```APIDOC
## Usage: :country Input

### Description
Configures a country select input within a Formtastic form. The :priority_countries option allows placing specific countries at the top of the select list.

### Request Example (country_select 1.x)
<%= semantic_form_for @user do |f| %>
  <%= f.inputs do %>
    <%= f.input :nationality, :as => :country, :priority_countries => ["Australia", "New Zealand"] %>
  <% end %>
<% end %>

### Request Example (country_select 2.x)
<%= semantic_form_for @user do |f| %>
  <%= f.inputs do %>
    <%= f.input :nationality, :as => :country, :priority_countries => ["AU", "NZ"] %>
  <% end %>
<% end %>
```

--------------------------------

### Configure blank options

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Timeish

Toggle the presence of a blank option at the start of each select menu.

```erb
<%= f.input :publish_at, :as => :time_select, :include_blank => true %>
<%= f.input :publish_at, :as => :time_select, :include_blank => false %>
```

--------------------------------

### Formtastic TimePickerInput Full Form Example

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/TimePickerInput

Demonstrates how to use the time_picker input type within a Formtastic form. This example shows the full form context and the resulting HTML output, including a label and an input element for a time field.

```erb
<%= semantic_form_for(@post) do |f| %>
  <%= f.inputs do %>
    <%= f.input :publish_at, :as => :time_picker %>
  <% end %>
<% end %>

<form...>
  <fieldset>
    <ol>
      <li class="string">
        <label for="post_publish_at">First name</label>
        <input type="date" id="post_publish_at" name="post[publish_at]">
      </li>
    </ol>
  </fieldset>
</form>
```

--------------------------------

### Customizing Action Options

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Helpers/ActionsHelper

Provides an example of gaining full control over action options, including HTML attributes for buttons and wrappers.

```erb
<% semantic_form_for @post do |f| %>
  ...
  <%= f.actions do %>
    <%= f.action :label => "Go", :button_html => { :class => "pretty" :disable_with => "Wait..." }, :wrapper_html => { ... }
  <% end %>
<% end %>

```

--------------------------------

### Install Formtastic gem

Source: https://rubydoc.info/github/formtastic/formtastic/master/file/README.md

Add the gem to your Gemfile to include Formtastic in your Rails project.

```ruby
gem 'formtastic', '~> 5.0'
```

--------------------------------

### Render Link Action in Form

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Actions/LinkAction

Shows a full semantic form example including a submit input and a cancel link action.

```erb

<%= semantic_form_for(@post) do |f| %>
  <%= f.actions do %>
    <%= f.action :submit, :as => :input %>
    <%= f.action :cancel, :as => :link %>
  <% end %>
<% end %>

<form...>
  <fieldset class="actions">
    <ol>
      <li class="action input_action" id="post_submit_action">
        <input type="submit" value="Create Post">
      </li>
      <li class="action link_action" id="post_cancel_action">
        <a href="javascript:history.back()">Cancel</a>
      </li>
    </ol>
  </fieldset>
</form>
```

--------------------------------

### Render Full Form Context

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Actions/InputAction

Example of using input actions within a semantic_form_for block to generate a fieldset of actions.

```erb

<%= semantic_form_for(@post) do |f| %>
  <%= f.actions do %>
    <%= f.action :reset, :as => :input %>
    <%= f.action :submit, :as => :input %>
  <% end %>
<% end %>

<form...>
  <fieldset class="actions">
    <ol>
      <li class="action input_action" id="post_reset_action">
        <input type="reset" value="Reset">
      </li>
      <li class="action input_action" id="post_submit_action">
        <input type="submit" value="Create Post">
      </li>
    </ol>
  </fieldset>
</form>
```

--------------------------------

### Generate basic string input markup

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Helpers/InputHelper%3Ainput

Example of generating a standard string input field with required validation.

```erb
<%= f.input :title, :as => :string, :required => true %>

<li class="string required" id="post_title_input">
  <label for="post_title">Title<abbr title="Required">*</abbr></label>
  <input type="text" name="post[title]" value="" id="post_title" required="required">
</li>
```

--------------------------------

### Example HTML output for form inputs

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Helpers/InputHelper

The generated HTML structure for form inputs wrapped in fieldset and list elements.

```html
<form class="formtastic" method="post" action="...">
  <fieldset>
    <ol>
      <li class="string required" id="post_title_input">
        ...
      </li>
      <li class="text required" id="post_body_input">
        ...
      </li>
    </ol>
  </fieldset>
</form>
```

--------------------------------

### Define nested attributes models

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Helpers/InputsHelper

Example model setup for using nested attributes with ActiveRecord.

```ruby
# Models
class User < ActiveRecord::Base
  has_one :profile
  accepts_nested_attributes_for :profile
end
class Profile < ActiveRecord::Base
  belongs_to :user
end
```

--------------------------------

### Range Input with :min, :max, :step Options

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/RangeInput

Illustrates using :min, :max, and :step as direct options for the input, which are then passed to :input_html.

```APIDOC
## PUT /api/users/{id}

### Description
Updates an existing user resource identified by their unique identifier.

### Method
PUT

### Endpoint
/api/users/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the user to update.

#### Request Body
- **name** (string) - Optional - The updated name of the user.
- **email** (string) - Optional - The updated email address of the user.

### Request Example
```json
{
  "name": "Jane Doe",
  "email": "jane.doe@example.com"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the updated user.
- **name** (string) - The updated name of the user.
- **email** (string) - The updated email address of the user.

#### Response Example
```json
{
  "id": 123,
  "name": "Jane Doe",
  "email": "jane.doe@example.com"
}
```
```

--------------------------------

### Create FlexibleTextInput Based on StringInput

Source: https://rubydoc.info/github/formtastic/formtastic/master/file/README.md

Create a new input type by subclassing an existing one, like `StringInput`. This example adds a CSS class and a custom hint.

```ruby
class FlexibleTextInput < Formtastic::Inputs::StringInput
    def input_html_options
      super.merge(:class => "flexible-text-area")
    end

    def options
      super.merge(hint: 'This is a flexible text area')
    end
  end
```

--------------------------------

### Get hint text

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Hints

Retrieves the hint text, attempting localization. This method is used internally to get the actual text content for the hint.

```ruby
def hint_text
  localized_string(method, options[:hint], :hint)
end
```

--------------------------------

### Copy Scaffold Template - Formtastic Install Generator

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/InstallGenerator%3Acopy_scaffold_template

Copies the scaffold form template for the specified template engine. This method is part of the Formtastic install generator.

```ruby
def copy_scaffold_template
  engine = options[:template_engine]
  copy_file "_form.html.#{engine}", "lib/templates/#{engine}/scaffold/_form.html.#{engine}"
end
```

--------------------------------

### Instance Method Summary

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Timeish

A summary of all available instance methods for timeish inputs.

```APIDOC
## Instance Method Summary

* #**date_fragments** ⇒ Object
* #**default_date_fragments** ⇒ Object
* #**fragment_id**(fragment) ⇒ Object
* #**fragment_input_html**(fragment) ⇒ Object
* #**fragment_label**(fragment) ⇒ Object
* #**fragment_label_html**(fragment) ⇒ Object
* #**fragment_name**(fragment) ⇒ Object
* #**fragment_prefix** ⇒ Object
* #**fragment_wrapping**(&block) ⇒ Object
* #**fragment_wrapping_html_options** ⇒ Object
* #**fragments** ⇒ Object
* #**fragments_inner_wrapping**(&block) ⇒ Object
* #**fragments_label** ⇒ Object
* #**fragments_wrapping**(&block) ⇒ Object
* #**fragments_wrapping_html_options** ⇒ Object
* #**hidden_field_name**(fragment) ⇒ Object
* #**hidden_fragments** ⇒ Object
* #**i18n_date_fragments** ⇒ Object
* #**include_blank?** ⇒ Boolean
* #**position**(fragment) ⇒ Object
* #**positions** ⇒ Object
* #**time_fragments** ⇒ Object
* #**to_html** ⇒ Object
* #**value** ⇒ Object
```

--------------------------------

### Initialization and Core Methods

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Actions/Base

Details on initializing an action object and core methods like text and HTML generation.

```APIDOC
## POST /api/actions/initialize

### Description
Initializes a new action object with the provided builder, template, object, object name, method, and options.

### Method
POST

### Endpoint
/api/actions/initialize

### Parameters
#### Request Body
- **builder** (Object) - The builder instance.
- **template** (Object) - The template instance.
- **object** (Object) - The object the action is associated with.
- **object_name** (String) - The name of the object.
- **method** (String) - The method name.
- **options** (Object) - A hash of options for the action.

### Request Example
```json
{
  "builder": "<builder_instance>",
  "template": "<template_instance>",
  "object": {
    "id": 1,
    "name": "Test User"
  },
  "object_name": "user",
  "method": "update",
  "options": {
    "label": "Update User"
  }
}
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation of successful initialization.

#### Response Example
```json
{
  "message": "Action initialized successfully."
}
```
```

```APIDOC
## GET /api/actions/text

### Description
Returns the display text for the action, prioritizing options[:label] and falling back to internationalized strings.

### Method
GET

### Endpoint
/api/actions/text

### Response
#### Success Response (200)
- **text** (String) - The display text for the action.

#### Response Example
```json
{
  "text": "Update"
}
```
```

```APIDOC
## GET /api/actions/to_html

### Description
Abstract method to generate the HTML representation of the action. Raises `NotImplementedError` if not implemented by subclasses.

### Method
GET

### Endpoint
/api/actions/to_html

### Response
#### Error Response (500)
- **error** (String) - Indicates that the method is not implemented.

#### Response Example
```json
{
  "error": "NotImplementedError"
}
```
```

--------------------------------

### Initialization

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Actions/Base

Initializes the action instance with builder, template, object, and options.

```ruby
# File 'lib/formtastic/actions/base.rb', line 9

def initialize(builder, template, object, object_name, method, options)
  @builder = builder
  @template = template
  @object = object
  @object_name = object_name
  @method = method
  @options = options.dup
  
  check_supported_methods!
end
```

--------------------------------

### Formtastic::Localizer::Cache#get

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Localizer/Cache%3Aget

Retrieves a value from the cache using a given key.

```APIDOC
## Formtastic::Localizer::Cache#get

### Description
Retrieves a value from the cache using a given key.

### Method
GET

### Endpoint
N/A (This is a class method within a Ruby library)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
localizer_cache.get(:some_key)
```

### Response
#### Success Response (200)
- **Object** - The value associated with the key, or nil if not found.

#### Response Example
```json
"some_value"
```
```

--------------------------------

### String Input Example

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/StringInput

Demonstrates the full form context and the resulting HTML output for a string input. This input is the default for string database columns and can be explicitly set using `:as => :string`.

```erb
<%= semantic_form_for(@user) do |f| %>
  <%= f.inputs do %>
    <%= f.input :first_name, :as => :string %>
  <% end %>
<% end %>

<form...>
  <fieldset>
    <ol>
      <li class="string">
        <label for="user_first_name">First name</label>
        <input type="text" id="user_first_name" name="user[first_name]">
      </li>
    </ol>
  </fieldset>
</form>
```

--------------------------------

### GET Formtastic::Inputs::CheckBoxesInput#unchecked_value

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/CheckBoxesInput%3Aunchecked_value

Retrieves the value to be submitted when a checkbox is unchecked.

```APIDOC
## GET Formtastic::Inputs::CheckBoxesInput#unchecked_value

### Description
Returns the value that should be submitted when the checkbox is not selected. It checks the options hash for a provided value, defaulting to an empty string.

### Method
GET

### Endpoint
Formtastic::Inputs::CheckBoxesInput#unchecked_value

### Response
#### Success Response (200)
- **value** (Object) - The value to be submitted for an unchecked checkbox.
```

--------------------------------

### SelectInput Instance Methods

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/SelectInput

Documentation for various instance methods of the SelectInput class.

```APIDOC
## extra_input_html_options

### Description
Provides additional HTML options for the input element, including `multiple` and `name` attributes.

### Method
extra_input_html_options

### Response
#### Success Response (200)
- **Hash** - A hash containing HTML options like `:multiple` and `:name`.

### Response Example
```json
{
  "multiple": true,
  "name": "object_name[attribute_name][]"
}
```
```

```APIDOC
## include_blank

### Description
Determines whether to include a blank option in the select input. It checks if `:include_blank` is explicitly set in options or defaults based on single selection and builder settings.

### Method
include_blank

### Response
#### Success Response (200)
- **Boolean** - `true` if a blank option should be included, `false` otherwise.

### Response Example
```json
true
```
```

```APIDOC
## input_html_options

### Description
Merges extra input HTML options with the superclass's input HTML options, excluding the `:name` key if its value is nil.

### Method
input_html_options

### Response
#### Success Response (200)
- **Hash** - A hash of merged HTML options for the input element.

### Response Example
```json
{
  "multiple": false,
  "name": "object_name[attribute_name]",
  "id": "object_id"
}
```
```

```APIDOC
## input_html_options_name

### Description
Generates the `name` attribute for the input element, considering whether an index is present (for nested forms).

### Method
input_html_options_name

### Response
#### Success Response (200)
- **String** - The generated name attribute string.

### Response Example
```json
"user[addresses][0][street]"
```
```

```APIDOC
## input_html_options_name_multiple

### Description
Appends `[]` to the input name to indicate a multiple select input.

### Method
input_html_options_name_multiple

### Response
#### Success Response (200)
- **String** - The generated name attribute string for multiple selections.

### Response Example
```json
"user[roles][]"
```
```

```APIDOC
## input_options

### Description
Merges the `include_blank` option into the input options, unless a prompt is present.

### Method
input_options

### Response
#### Success Response (200)
- **Hash** - A hash of input options, potentially including `:include_blank`.

### Response Example
```json
{
  "include_blank": true
}
```
```

```APIDOC
## label_html_options

### Description
Merges the `for` attribute with the input's ID into the label's HTML options.

### Method
label_html_options

### Response
#### Success Response (200)
- **Hash** - A hash of HTML options for the label element.

### Response Example
```json
{
  "for": "user_email"
}
```
```

```APIDOC
## multiple?

### Description
Determines if the select input should allow multiple selections. It checks both options and association reflection.

### Method
multiple?

### Response
#### Success Response (200)
- **Boolean** - `true` if multiple selections are allowed, `false` otherwise.

### Response Example
```json
true
```
```

```APIDOC
## multiple_by_association?

### Description
Checks if the input is configured for multiple selections based on the association type (e.g., `has_many`, `has_and_belongs_to_many`).

### Method
multiple_by_association?

### Response
#### Success Response (200)
- **Boolean** - `true` if the association type implies multiple selections, `false` otherwise.

### Response Example
```json
false
```
```

```APIDOC
## multiple_by_options?

### Description
Checks if the input is configured for multiple selections directly through options or `input_html` options.

### Method
multiple_by_options?

### Response
#### Success Response (200)
- **Boolean** - `true` if options indicate multiple selections, `false` otherwise.

### Response Example
```json
true
```
```

```APIDOC
## prompt?

### Description
Determines if a prompt (like 'Please select') should be displayed. This is typically related to the `include_blank` option.

### Method
prompt?

### Response
#### Success Response (200)
- **Boolean** - `true` if a prompt should be displayed, `false` otherwise.

### Response Example
```json
false
```
```

--------------------------------

### SelectInput Initialization

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/SelectInput

Details the constructor for SelectInput, including its arguments and potential exceptions.

```APIDOC
## initialize(*args)

### Description
Returns a new instance of SelectInput.

### Method
initialize

### Parameters
*args - Arguments for initialization.

### Raises
* (`Formtastic::UnsupportedEnumCollection`) - Raised when the collection is from an enum and the input is multiple.

### Request Example
```ruby
# Example usage (conceptual)
select_input = SelectInput.new(object, attribute, collection, options)
```

### Response Example
```ruby
# Returns a new SelectInput instance
```
```

--------------------------------

### to_html

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Timeish

Main entry point for rendering the timeish input.

```APIDOC
## to_html

### Description
Generates the full HTML structure for the timeish input, including wrappers, labels, and individual fragment inputs.
```

--------------------------------

### CLI: rails generate formtastic:install

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/InstallGenerator

The primary command to initialize Formtastic in a Rails project. This copies the configuration initializer to the application.

```APIDOC
## CLI: rails generate formtastic:install

### Description
Copies the default Formtastic configuration initializer to `config/initializers/formtastic.rb`.

### Method
CLI Command

### Request Example
```bash
rails generate formtastic:install
```
```

--------------------------------

### Color Input Instance Methods

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/ColorInput

Details the instance methods available for the Color Input, including those inherited from various modules.

```APIDOC
## Instance Method Details

### permalink #**to_html** ⇒ `Object`

#### Description
Generates the HTML for the color input field.

#### Method
`to_html`

#### Endpoint
N/A (Instance Method)

#### Parameters
None

#### Request Body
None

### Request Example
```ruby
# Assuming an instance of a form with a color input field
# For example:
# form.input :favorite_color, as: :color
```

### Response
#### Success Response (HTML Output)
- **HTML String** - The generated HTML for the color input field, including label and input element.

#### Response Example
```html
<div class="color input string required">
  <label class="string required" for="post_favorite_color">
    Favorite color <abbr title="required">*</abbr>
  </label>
  <input class="string color" id="post_favorite_color" name="post[favorite_color]" size="30" type="color" value="">
</div>
```
```

--------------------------------

### GET Formtastic::Localizer::Cache#has_key?

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Localizer/Cache%3Ahas_key%3F

Checks if the localizer cache contains a specific key.

```APIDOC
## GET Formtastic::Localizer::Cache#has_key?

### Description
Checks if the provided key exists within the Formtastic localizer cache.

### Parameters
#### Path Parameters
- **key** (Object) - Required - The key to check for in the cache.

### Response
#### Success Response (200)
- **Boolean** - Returns true if the key exists in the cache, false otherwise.
```

--------------------------------

### Get value or default

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/TimeSelectInput

Returns the current value if present, otherwise defaults to the current time.

```ruby
# File 'lib/formtastic/inputs/time_select_input.rb', line 19

def value_or_default_value
  value ? value : Time.current
end
```

--------------------------------

### Retrieve cached value using get

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Localizer/Cache%3Aget

Retrieves a value from the cache based on the provided key.

```ruby
# File 'lib/formtastic/localizer.rb', line 29

def get(key)
  cache[key]
end
```

--------------------------------

### Min/Max/Step as Direct Options

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/RangeInput

The min, max, and step options can be provided directly to the f.input method, overriding or supplementing those set in :input_html.

```HTML+ERB
<%= f.input :shoe_size, :as => :range, :min => 3, :max => 15, :step => 1, :input_html => { :class => "special" } %>
```

--------------------------------

### Range Input Instance Methods

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/RangeInput

Details the instance methods available for range inputs, including min_option, max_option, step_option, and to_html.

```APIDOC
## GET /api/products

### Description
Retrieves a list of products.

### Method
GET

### Endpoint
/api/products

### Parameters
#### Query Parameters
- **category** (string) - Optional - Filter products by category.
- **sort_by** (string) - Optional - Field to sort products by (e.g., 'price', 'name').
- **order** (string) - Optional - Sort order ('asc' or 'desc'). Defaults to 'asc'.

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.
  - **id** (integer) - The unique identifier for the product.
  - **name** (string) - The name of the product.
  - **price** (number) - The price of the product.
  - **category** (string) - The category of the product.

#### Response Example
```json
{
  "products": [
    {
      "id": 1,
      "name": "Laptop",
      "price": 1200.00,
      "category": "Electronics"
    },
    {
      "id": 2,
      "name": "Desk Chair",
      "price": 250.50,
      "category": "Furniture"
    }
  ]
}
```
```

--------------------------------

### Get Raw Wrapper HTML Options

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Wrapping%3Awrapper_html_options_raw

Retrieves the raw HTML options for the wrapper element. It duplicates the options to prevent modification of the original.

```Ruby
def wrapper_html_options_raw
  (options[:wrapper_html] || {}).dup
end
```

--------------------------------

### Create DatePickerInput From Scratch

Source: https://rubydoc.info/github/formtastic/formtastic/master/file/README.md

Create a custom input from scratch by including `Formtastic::Inputs::Base` and implementing the `to_html` method. The `to_html` method can contain custom rendering logic or call `super` if extending a base class not explicitly shown.

```ruby
class DatePickerInput
    include Formtastic::Inputs::Base
    def to_html
      # ...
    end
  end
```

--------------------------------

### GET Formtastic::Inputs::TimePickerInput#default_step

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/TimePickerInput%3Adefault_step

Retrieves the default step value for the TimePickerInput component.

```APIDOC
## GET Formtastic::Inputs::TimePickerInput#default_step

### Description
Returns the default step value used by the TimePickerInput component.

### Method
GET

### Response
#### Success Response (200)
- **value** (Integer) - The default step value, which is 60.
```

--------------------------------

### GET Formtastic Input Options

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Options%3Aformtastic_options

Retrieves the list of available configuration options for Formtastic inputs.

```APIDOC
## GET /formtastic/inputs/base/options

### Description
Returns the list of supported options that can be passed to Formtastic inputs.

### Method
GET

### Response
#### Success Response (200)
- **options** (Array) - A list of symbols representing valid input configuration keys.

#### Response Example
[
  "priority_countries",
  "priority_zones",
  "member_label",
  "member_value",
  "collection",
  "required",
  "label",
  "as",
  "hint",
  "input_html",
  "value_as_class",
  "class"
]
```

--------------------------------

### Formtastic::Inputs::Base::Labelling Instance Methods

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Labelling

This section details the instance methods available within the Formtastic::Inputs::Base::Labelling module, which are responsible for managing input labels.

```APIDOC
## Instance Method Summary

- `#label_from_options` ⇒ Object
- `#label_html` ⇒ Object
- `#label_html_options` ⇒ Object
- `#label_text` ⇒ Object
- `#localized_label` ⇒ Object
- `#render_label?` ⇒ Boolean
- `#requirement_text` ⇒ Object
- `#requirement_text_or_proc` ⇒ Object

## Instance Method Details

### permalink #`label_from_options` ⇒ `Object`

```ruby
# File 'lib/formtastic/inputs/base/labelling.rb', line 37
def label_from_options
  options[:label]
end
```

### permalink #`label_html` ⇒ `Object`

```ruby
# File 'lib/formtastic/inputs/base/labelling.rb', line 9
def label_html
  render_label? ? builder.label(input_name, label_text, label_html_options) : "".html_safe
end
```

### permalink #`label_html_options` ⇒ `Object`

```ruby
# File 'lib/formtastic/inputs/base/labelling.rb', line 13
def label_html_options
  {
    :for => input_html_options[:id],
    :class => ['label'],
  }.merge(options[:label_html] || {})
end
```
```

--------------------------------

### ColorInput Full Form Example

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/ColorInput

Demonstrates how to use the ColorInput within a Formtastic form. This is the default input for attributes named 'color' or can be specified with `:as => :color`.

```erb
<%= semantic_form_for(@user) do |f| %>
  <%= f.inputs do %>
    <%= f.input :color, :as => :color %>
  <% end %>
<% end %>
```

```html
<form...>
  <fieldset>
    <ol>
      <li class="color">
        <label for="user_color">Color</label>
        <input type="color" id="user_color" name="user[color]">
      </li>
    </ol>
  </fieldset>
</form>
```

--------------------------------

### Form with Localized Labels and Hints

Source: https://rubydoc.info/github/formtastic/formtastic/master/file/README.md

Example of a Formtastic form where labels and hints are automatically localized based on the I18n configuration and YAML translations.

```erb
<%= semantic_form_for Post.new do |f| %>
  <%= f.inputs do %>
    <%= f.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for your post."
    <%= f.input :body %>       # => :label => "Write something...", :hint => "Write something inspiring here."
    <%= f.input :section %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
  <% end %> 
  <%= f.actions do %>
    <%= f.action :submit %>   # => "Create my %{model}"
  <% end %> 
<% end %>
```

--------------------------------

### Formtastic::Inputs::Base::Choices Instance Methods

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Choices

This section details the instance methods available in the Formtastic::Inputs::Base::Choices module, including their purpose and usage.

```APIDOC
## Formtastic::Inputs::Base::Choices Instance Methods

### Description
Provides methods for generating and managing HTML for choices within form inputs.

### Methods
- `choice_html(choice)`: Generates the HTML for a single choice. Raises an error if not implemented.
- `choice_html_options(choice)`: Generates HTML options for a single choice.
- `choice_html_safe_value(choice)`: Returns the safe HTML value for a choice.
- `choice_input_dom_id(choice)`: Generates the DOM ID for a choice input.
- `choice_label(choice)`: Returns the display label for a choice.
- `choice_value(choice)`: Returns the value of a choice.
- `choice_wrapping(html_options, &block)`: Wraps the HTML for a choice.
- `choice_wrapping_html_options(choice)`: Generates HTML options for the choice wrapping element.
- `choices_group_wrapping(&block)`: Wraps a group of choices.
- `choices_group_wrapping_html_options`: Returns HTML options for the choices group wrapping element.
- `choices_wrapping(&block)`: Wraps all choices.
- `choices_wrapping_html_options`: Returns HTML options for the choices wrapping element.
- `custom_choice_html_options(choice)`: Generates custom HTML options for a choice.
- `default_choice_html_options(choice)`: Generates default HTML options for a choice.
- `label_html_options`: Returns HTML options for the label element.
- `legend_html`: Returns the HTML for the legend element, overriding the default to remove the 'for' attribute.
- `value_as_class?`: Returns a boolean indicating if the value should be used as a CSS class.
```

--------------------------------

### GET Formtastic::Inputs::CheckBoxesInput#disabled?

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/CheckBoxesInput%3Adisabled%3F

Checks if a specific value is disabled within the CheckBoxesInput component.

```APIDOC
## GET Formtastic::Inputs::CheckBoxesInput#disabled?

### Description
Determines whether a given value is present in the list of disabled values for a checkbox input.

### Method
GET

### Parameters
#### Query Parameters
- **value** (Object) - Required - The value to check against the disabled list.

### Response
#### Success Response (200)
- **result** (Boolean) - Returns true if the value is disabled, false otherwise.
```

--------------------------------

### fragments

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Timeish

Combines date fragments and time fragments to get the complete list of fragments for a timeish input.

```APIDOC
## GET /formtastic/inputs/timeish/fragments

### Description
Retrieves the combined list of date and time fragments.

### Method
GET

### Endpoint
/formtastic/inputs/timeish/fragments

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **fragments** (Array) - An array containing both date and time fragment names.

### Response Example
```json
{
  "fragments": [
    "year",
    "month",
    "day",
    "hour",
    "minute"
  ]
}
```
```

--------------------------------

### GET #input_html_options

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/TextInput

Retrieves the HTML options for the text area input, including default columns and rows.

```APIDOC
## GET #input_html_options

### Description
Returns a hash of HTML attributes for the text area, merging default dimensions (cols/rows) with any provided options.

### Response
- **Hash** - A collection of HTML attributes including :cols and :rows.
```

--------------------------------

### Instance Method Details: Time Select Input

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/TimeSelectInput

Details of instance methods for the Time Select Input, including their purpose, parameters, and return values.

```APIDOC
## Instance Method: fragment_value

### Description
Retrieves the value for a given fragment (e.g., year, month, day) from the current value or a default value.

### Method
`fragment_value(fragment)`

### Parameters
- **fragment** (Object) - The fragment for which to retrieve the value.

### Response
- **Object** - The value corresponding to the fragment.

### Request Example
```ruby
# Assuming 'input' is an instance of TimeSelectInput
input.fragment_value(:year)
```

### Response Example
```ruby
2023
```
```

```APIDOC
## Instance Method: fragments

### Description
Returns the time fragments (year, month, day, hour, minute) to be used for the time select input. It omits year, month, and day fragments if the `:ignore_date` option is set to true.

### Method
`fragments`

### Response
- **Array** - An array of time fragments.

### Request Example
```ruby
# Assuming 'input' is an instance of TimeSelectInput
input.fragments
```

### Response Example
```ruby
[:year, :month, :day, :hour, :minute]
```
```

```APIDOC
## Instance Method: hidden_fragments

### Description
Generates hidden input fields for date fragments (year, month, day) if `:ignore_date` is not set to true. Otherwise, it calls the superclass method.

### Method
`hidden_fragments`

### Response
- **String** - HTML string containing hidden input fields for date fragments, or the result from the superclass.

### Request Example
```ruby
# Assuming 'input' is an instance of TimeSelectInput
input.hidden_fragments
```

### Response Example
```html
<input id="user_birthday_1i" name="user[birthday(1i)]" type="hidden" value="2023" disabled="disabled" />
<input id="user_birthday_2i" name="user[birthday(2i)]" type="hidden" value="10" disabled="disabled" />
<input id="user_birthday_3i" name="user[birthday(3i)]" type="hidden" value="26" disabled="disabled" />
```
```

```APIDOC
## Instance Method: value_or_default_value

### Description
Returns the current value of the input or the current time if no value is set.

### Method
`value_or_default_value`

### Response
- **Object** - The current value or the current time.

### Request Example
```ruby
# Assuming 'input' is an instance of TimeSelectInput
input.value_or_default_value
```

### Response Example
```ruby
# If a value is set:
# 2023-10-26 10:30:00 +0000
# If no value is set:
# 2023-10-26 10:30:00 +0000 (current time)
```
```

--------------------------------

### GET Formtastic::Inputs::TimeSelectInput#fragment_value

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/TimeSelectInput%3Afragment_value

Retrieves the value for a specific time fragment from the input object.

```APIDOC
## GET Formtastic::Inputs::TimeSelectInput#fragment_value

### Description
Retrieves the value for a specific time fragment (e.g., hour, minute, second) from the current value or default value of the TimeSelectInput.

### Parameters
#### Path Parameters
- **fragment** (Object) - Required - The specific time fragment to retrieve (e.g., :hour, :min).

### Response
#### Success Response (200)
- **value** (Object) - The value associated with the requested fragment.
```

--------------------------------

### Render :time_select and :datetime_select inputs

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Timeish

Basic implementation of time and datetime selection inputs.

```erb
<%= f.input :publish_at, :as => :time_select %>
```

```erb
<%= f.input :publish_at, :as => :datetime_select %>
```

--------------------------------

### GET Formtastic::Inputs::TimePickerInput#html_input_type

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/TimePickerInput%3Ahtml_input_type

Retrieves the HTML input type string for the TimePickerInput component.

```APIDOC
## GET Formtastic::Inputs::TimePickerInput#html_input_type

### Description
Returns the HTML input type attribute value for the TimePickerInput component.

### Method
GET

### Response
#### Success Response (200)
- **type** (String) - The HTML input type, which is "time".
```

--------------------------------

### Formtastic::Inputs::Base::Placeholder Module

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Placeholder

This section details the instance methods available within the Formtastic::Inputs::Base::Placeholder module.

```APIDOC
## Module: Formtastic::Inputs::Base::Placeholder

### Description
This module provides functionality for handling placeholder text in form inputs. It is included in various input types to manage placeholder attributes.

### Included in
- DatetimePickerish
- ColorInput
- EmailInput
- NumberInput
- PasswordInput
- PhoneInput
- SearchInput
- StringInput
- TextInput
- UrlInput

### Defined in
- lib/formtastic/inputs/base/placeholder.rb

## Instance Method Summary

- `#input_html_options` ⇒ Object
- `#placeholder_text` ⇒ Object

## Instance Method Details

### permalink #`input_html_options` ⇒ `Object`

#### Description
Merges the placeholder option with existing HTML input options.

#### Code
```ruby
def input_html_options
  {:placeholder => placeholder_text}.merge(super)
end
```

### permalink #`placeholder_text` ⇒ `Object`

#### Description
Retrieves the localized placeholder text for a given method and options.

#### Code
```ruby
def placeholder_text
  localized_string(method, options[:placeholder], :placeholder)
end
```
```

--------------------------------

### Formtastic::Inputs::Base::Wrapping Instance Methods

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Wrapping

This section details the instance methods available within the Formtastic::Inputs::Base::Wrapping module, including input_wrapping, wrapper_classes, and related methods.

```APIDOC
## Instance Method: input_wrapping

### Description
Override this method if you want to change the display order (for example, rendering the errors before the body of the input).

### Method
Instance Method

### Endpoint
N/A (Instance Method)

### Parameters
- **block** (Proc) - Optional - A block of code to be rendered within the input wrapping.

### Request Example
```ruby
# Example usage within a Formtastic form:
def input_wrapping(&block)
  template.content_tag(:li, [template.capture(&block), error_html, hint_html].join("\n").html_safe, wrapper_html_options)
end
```

### Response
#### Success Response (200)
- **Object** - The rendered HTML for the input wrapper.

#### Response Example
```html
<li>
  <!-- Content from the block -->
  <p>Error messages</p>
  <p>Hint text</p>
</li>
```
```

```APIDOC
## Instance Method: wrapper_classes

### Description
Returns an array of CSS classes to be applied to the input wrapper.

### Method
Instance Method

### Endpoint
N/A (Instance Method)

### Parameters
None

### Request Example
```ruby
# Example usage within a Formtastic form:
def wrapper_classes
  classes = wrapper_classes_raw
  classes << as
  classes << "input"
  classes << "error" if errors?
  classes << "optional" if optional?
  classes << "required" if required?
  classes << "autofocus" if autofocus?

  classes.join(' ')
end
```

### Response
#### Success Response (200)
- **String** - A space-separated string of CSS classes.

#### Response Example
```
"string input error optional required autofocus"
```
```

```APIDOC
## Instance Method: wrapper_classes_raw

### Description
Returns the raw array of CSS classes before additional classes are appended.

### Method
Instance Method

### Endpoint
N/A (Instance Method)

### Parameters
None

### Request Example
```ruby
# Example usage within a Formtastic form:
def wrapper_classes_raw
  # ... implementation details ...
end
```

### Response
#### Success Response (200)
- **Array** - An array of raw CSS class strings.

#### Response Example
```
["some-class", "another-class"]
```
```

```APIDOC
## Instance Method: wrapper_dom_id

### Description
Returns the DOM ID for the input wrapper.

### Method
Instance Method

### Endpoint
N/A (Instance Method)

### Parameters
None

### Request Example
```ruby
# Example usage within a Formtastic form:
def wrapper_dom_id
  # ... implementation details ...
end
```

### Response
#### Success Response (200)
- **String** - The DOM ID string.

#### Response Example
```
"user_name_input"
```
```

```APIDOC
## Instance Method: wrapper_html_options

### Description
Returns the HTML options hash for the input wrapper.

### Method
Instance Method

### Endpoint
N/A (Instance Method)

### Parameters
None

### Request Example
```ruby
# Example usage within a Formtastic form:
def wrapper_html_options
  # ... implementation details ...
end
```

### Response
#### Success Response (200)
- **Hash** - A hash containing HTML attributes for the wrapper.

#### Response Example
```json
{
  "class": "string input required",
  "id": "user_name_input"
}
```
```

```APIDOC
## Instance Method: wrapper_html_options_raw

### Description
Returns the raw HTML options hash before additional options are merged.

### Method
Instance Method

### Endpoint
N/A (Instance Method)

### Parameters
None

### Request Example
```ruby
# Example usage within a Formtastic form:
def wrapper_html_options_raw
  # ... implementation details ...
end
```

### Response
#### Success Response (200)
- **Hash** - A hash containing raw HTML attributes for the wrapper.

#### Response Example
```json
{
  "data-custom": "value"
}
```
```

--------------------------------

### Get column limit

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Validations

Calculates the character limit for a column, including specific handling for integer types.

```ruby
def column_limit
  return unless column?
  return unless column.respond_to?(:limit)

  limit = column.limit # already in characters for string, text, etc

  if column.type == :integer && column.limit.is_a?(Integer)
    return {
      1 => 3, # 8 bit
      2 => 5, # 16 bit
      3 => 7, # 24 bit
      4 => 10, # 32 bit
      8 => 19, # 64 bit
    }[limit] || nil
  end

  return limit
end
```

--------------------------------

### GET Formtastic::Inputs::Base#object_name

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base%3Aobject_name

Retrieves the object_name attribute from the Formtastic input base class.

```APIDOC
## GET Formtastic::Inputs::Base#object_name

### Description
Returns the value of the object_name attribute defined within the Formtastic input base class.

### Method
GET

### Endpoint
Formtastic::Inputs::Base#object_name

### Response
#### Success Response (200)
- **object_name** (Object) - The name of the object associated with the input.
```

--------------------------------

### Implement to_html for Input Rendering

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Html%3Ato_html

Implement this method in your input class to describe how the input should render itself. Defines how the instance of an input should be rendered to a HTML string. This is an abstract method and must be implemented.

```ruby
def to_html
  input_wrapping do
    label_html <<
    builder.text_field(method, input_html_options)
  end
end
```

```ruby
def to_html
  raise NotImplementedError
end
```

--------------------------------

### GET Formtastic::Inputs::Base::Errors#errors?

Source: https://rubydoc.info/github/formtastic/formtastic/master/Formtastic/Inputs/Base/Errors%3Aerrors%3F

Checks if there are any validation errors associated with the input field.

```APIDOC
## GET Formtastic::Inputs::Base::Errors#errors?

### Description
Returns a boolean indicating whether the current input field has any associated errors. It checks if the errors collection is not blank.

### Response
#### Success Response (200)
- **Boolean** - Returns true if errors exist, false otherwise.
```
Tokens:
Raw