Module: Herb::ActionView::HelperRegistry
- Defined in:
- lib/herb/action_view/helper_registry.rb
Constant Summary collapse
- ACTION_CABLE_META_TAG =
HelperEntry.new( name: "action_cable_meta_tag", type: HelperType::ACTION_CABLE_META_TAG, source: "ActionCable::Helpers::ActionCableHelper#action_cable_meta_tag", gem: "actioncable", output: :html, visibility: "public", tag_name: "meta", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns an `\"action-cable-url\"` `<meta>` tag with the value of the URL specified in your configuration. Ensure this is above your JavaScript tag. Used by Action Cable to determine the URL of your WebSocket server.", signature: "action_cable_meta_tag", documentation_url: "https://api.rubyonrails.org/classes/ActionCable/Helpers/ActionCableHelper.html#method-i-action_cable_meta_tag", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CONTENT_SECURITY_POLICY_P =
: HelperEntry
HelperEntry.new( name: "content_security_policy?", type: HelperType::CONTENT_SECURITY_POLICY_P, source: "ActionController::ContentSecurityPolicy#content_security_policy?", gem: "actionpack", output: :boolean, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether a Content-Security-Policy is present for the current request.", signature: "content_security_policy?", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CONTENT_SECURITY_POLICY_NONCE =
: HelperEntry
HelperEntry.new( name: "content_security_policy_nonce", type: HelperType::CONTENT_SECURITY_POLICY_NONCE, source: "ActionController::ContentSecurityPolicy#content_security_policy_nonce", gem: "actionpack", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the Content-Security-Policy nonce for the current request. This nonce value is used in `<script>` and `<style>` tags to allow inline content when a CSP is configured with a nonce source.", signature: "content_security_policy_nonce", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- POLYMORPHIC_PATH =
: HelperEntry
HelperEntry.new( name: "polymorphic_path", type: HelperType::POLYMORPHIC_PATH, source: "ActionDispatch::Routing::PolymorphicRoutes#polymorphic_path", gem: "actionpack", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the path component of a URL for the given record. Like `polymorphic_url` but returns a path instead of a full URL.", signature: "polymorphic_path(record_or_hash_or_array, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionDispatch/Routing/PolymorphicRoutes.html#method-i-polymorphic_path", implicit_attribute: nil, arguments: [ HelperArgument.new("record_or_hash_or_array", 1, "object", false, nil, false, "An Active Record instance, class, array, or hash."), HelperArgument.new("options", 2, "hash", true, "{}", false, "URL options hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- POLYMORPHIC_URL =
: HelperEntry
HelperEntry.new( name: "polymorphic_url", type: HelperType::POLYMORPHIC_URL, source: "ActionDispatch::Routing::PolymorphicRoutes#polymorphic_url", gem: "actionpack", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the URL for the given record or array of records. Automatically resolves to the named route based on the class of the record.", signature: "polymorphic_url(record_or_hash_or_array, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionDispatch/Routing/PolymorphicRoutes.html#method-i-polymorphic_url", implicit_attribute: nil, arguments: [ HelperArgument.new("record_or_hash_or_array", 1, "object", false, nil, false, "An Active Record instance, class, array, or hash."), HelperArgument.new("options", 2, "hash", true, "{}", false, "URL options hash."), ], options: [ HelperOption.new("action", "symbol", nil, "Route action (e.g. `:edit`, `:new`)."), HelperOption.new("routing_type", "symbol", nil, "Whether to generate `:url` or `:path`. Defaults to `:url`."), ], special_behaviors: [], aliases: [], ).freeze
- FORM_AUTHENTICITY_TOKEN =
: HelperEntry
HelperEntry.new( name: "form_authenticity_token", type: HelperType::FORM_AUTHENTICITY_TOKEN, source: "ActionController::RequestForgeryProtection#form_authenticity_token", gem: "actionpack", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates the authenticity token for the current request. Returns the masked CSRF token string used for protecting forms against cross-site request forgery.", signature: "form_authenticity_token(form_options: {})", documentation_url: "https://api.rubyonrails.org/classes/ActionController/RequestForgeryProtection.html#method-i-form_authenticity_token", implicit_attribute: nil, arguments: [ ], options: [ HelperOption.new("form_options", "hash", nil, "A hash that may contain `:action` and `:method` keys for per-form CSRF tokens."), ], special_behaviors: [], aliases: [], ).freeze
- PROTECT_AGAINST_FORGERY_P =
: HelperEntry
HelperEntry.new( name: "protect_against_forgery?", type: HelperType::PROTECT_AGAINST_FORGERY_P, source: "ActionController::RequestForgeryProtection#protect_against_forgery?", gem: "actionpack", output: :boolean, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Checks if the controller allows forgery protection. Returns `true` if forgery protection is enabled and the session is active.", signature: "protect_against_forgery?", documentation_url: "https://api.rubyonrails.org/classes/ActionController/RequestForgeryProtection.html#method-i-protect_against_forgery-3F", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- RENDER_ACTION_TEXT_CONTENT =
: HelperEntry
HelperEntry.new( name: "render_action_text_content", type: HelperType::RENDER_ACTION_TEXT_CONTENT, source: "ActionText::ContentHelper#render_action_text_content", gem: "actiontext", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Renders Action Text content by processing attachments and sanitizing the resulting HTML. Sets `prefix_partial_path_with_controller_namespace` to `false`, renders attachments, and then sanitizes the content.", signature: "render_action_text_content(content)", documentation_url: "https://api.rubyonrails.org/classes/ActionText/ContentHelper.html#method-i-render_action_text_content", implicit_attribute: nil, arguments: [ HelperArgument.new("content", 1, "object", false, nil, false, "The Action Text content object to render."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SANITIZE_ACTION_TEXT_CONTENT =
: HelperEntry
HelperEntry.new( name: "sanitize_action_text_content", type: HelperType::SANITIZE_ACTION_TEXT_CONTENT, source: "ActionText::ContentHelper#sanitize_action_text_content", gem: "actiontext", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Sanitizes Action Text content HTML using the configured sanitizer, allowed tags, allowed attributes, and scrubber. Returns the sanitized HTML as an `html_safe` string.", signature: "sanitize_action_text_content(content)", documentation_url: "https://api.rubyonrails.org/classes/ActionText/ContentHelper.html#method-i-sanitize_action_text_content", implicit_attribute: nil, arguments: [ HelperArgument.new("content", 1, "object", false, nil, false, "The Action Text content object to sanitize."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- RICH_TEXTAREA_TAG =
: HelperEntry
HelperEntry.new( name: "rich_textarea_tag", type: HelperType::RICH_TEXTAREA_TAG, source: "ActionText::TagHelper#rich_textarea_tag", gem: "actiontext", output: :html, visibility: "public", tag_name: "trix-editor", is_void: false, supports_block: true, preferred_for_tag: true, supported: false, detect_style: :call_name, description: "Returns a `<trix-editor>` tag that instantiates the Trix JavaScript editor as well as a hidden field that Trix will write to on changes, so the content will be sent on form submissions.", signature: "rich_textarea_tag(name, value = nil, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionText/TagHelper.html#method-i-rich_textarea_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the hidden field and editor."), HelperArgument.new("value", 2, "string", true, "nil", false, "Initial content for the editor."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("class", "string", nil, "CSS class. Defaults to `\"trix-content\"` for default styles."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes. Includes direct_upload_url and blob_url_template by default."), ], special_behaviors: [], aliases: [], ).freeze
- ERROR_MESSAGE =
: HelperEntry
HelperEntry.new( name: "error_message", type: HelperType::ERROR_MESSAGE, source: "ActionView::Helpers::ActiveModelHelper#error_message", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the validation error message for the current field.", signature: "error_message", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- ERROR_WRAPPING =
: HelperEntry
HelperEntry.new( name: "error_wrapping", type: HelperType::ERROR_WRAPPING, source: "ActionView::Helpers::ActiveModelHelper#error_wrapping", gem: "actionview", output: :html, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Wraps the given HTML tag with error-specific markup when the associated field has validation errors.", signature: "error_wrapping(html_tag)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- OBJECT =
: HelperEntry
HelperEntry.new( name: "object", type: HelperType::OBJECT, source: "ActionView::Helpers::ActiveModelHelper#object", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the model object associated with the form builder.", signature: "object", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- APPLY_STYLESHEET_MEDIA_DEFAULT =
: HelperEntry
HelperEntry.new( name: "apply_stylesheet_media_default", type: HelperType::APPLY_STYLESHEET_MEDIA_DEFAULT, source: "ActionView::Helpers::AssetTagHelper#apply_stylesheet_media_default", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether `stylesheet_link_tag` applies a default `media` attribute.", signature: "apply_stylesheet_media_default", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- AUDIO_TAG =
: HelperEntry
HelperEntry.new( name: "audio_tag", type: HelperType::AUDIO_TAG, source: "ActionView::Helpers::AssetTagHelper#audio_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "audio", is_void: false, supports_block: true, preferred_for_tag: true, supported: false, detect_style: :call_name, description: "Returns an HTML `<audio>` tag for the sources. If sources is a string, a single `<audio>` tag will be returned. If sources is an array, an `<audio>` tag with nested `<source>` tags for each source will be returned. The sources can be full paths, files in your public audios directory, or Active Storage attachments.", signature: "audio_tag(*sources, **options)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-audio_tag", implicit_attribute: HelperImplicitAttribute.new( "src", "first_arg", nil, "audio_path", ["url"] ), arguments: [ HelperArgument.new("sources", 1, "string", false, nil, true, "One or more audio file paths or URLs."), ], options: [ HelperOption.new("controls", "boolean", nil, "Whether to show playback controls."), HelperOption.new("autoplay", "boolean", nil, "Whether to start playing automatically."), HelperOption.new("loop", "boolean", nil, "Whether audio loops."), HelperOption.new("preload", "string", nil, "Preload behavior (`\"auto\"`, `\"metadata\"`, `\"none\"`)."), ], special_behaviors: [], aliases: [], ).freeze
- AUTO_DISCOVERY_LINK_TAG =
: HelperEntry
HelperEntry.new( name: "auto_discovery_link_tag", type: HelperType::AUTO_DISCOVERY_LINK_TAG, source: "ActionView::Helpers::AssetTagHelper#auto_discovery_link_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "link", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<link>` tag that browsers and feed readers can use to auto-detect an RSS, Atom, or JSON feed. The type can be `:rss` (default), `:atom`, or `:json`.", signature: "auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-auto_discovery_link_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("type", 1, "symbol", true, ":rss", false, "Feed type (`:rss`, `:atom`, or `:json`)."), HelperArgument.new("url_options", 2, "hash", true, "{}", false, "URL options hash passed to `url_for`."), HelperArgument.new("tag_options", 3, "hash", true, "{}", false, "HTML attributes for the `<link>` tag."), ], options: [ HelperOption.new("title", "string", nil, "Title of the feed."), HelperOption.new("type", "string", nil, "MIME type override."), ], special_behaviors: [], aliases: [], ).freeze
- AUTO_INCLUDE_NONCE =
: HelperEntry
HelperEntry.new( name: "auto_include_nonce", type: HelperType::AUTO_INCLUDE_NONCE, source: "ActionView::Helpers::AssetTagHelper#auto_include_nonce", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether CSP nonce is automatically included in asset tags.", signature: "auto_include_nonce", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- AUTO_INCLUDE_NONCE_FOR_SCRIPTS =
: HelperEntry
HelperEntry.new( name: "auto_include_nonce_for_scripts", type: HelperType::AUTO_INCLUDE_NONCE_FOR_SCRIPTS, source: "ActionView::Helpers::AssetTagHelper#auto_include_nonce_for_scripts", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether CSP nonce is automatically included in `<script>` tags.", signature: "auto_include_nonce_for_scripts", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- AUTO_INCLUDE_NONCE_FOR_STYLES =
: HelperEntry
HelperEntry.new( name: "auto_include_nonce_for_styles", type: HelperType::AUTO_INCLUDE_NONCE_FOR_STYLES, source: "ActionView::Helpers::AssetTagHelper#auto_include_nonce_for_styles", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether CSP nonce is automatically included in `<style>` tags.", signature: "auto_include_nonce_for_styles", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FAVICON_LINK_TAG =
: HelperEntry
HelperEntry.new( name: "favicon_link_tag", type: HelperType::FAVICON_LINK_TAG, source: "ActionView::Helpers::AssetTagHelper#favicon_link_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "link", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<link>` tag for a favicon managed by the asset pipeline. If a page has no link like the one generated by this helper, browsers ask for /favicon.ico automatically. Defaults to `\"favicon.ico\"` with rel `\"icon\"` and type `\"image/x-icon\"`.", signature: "favicon_link_tag(source = \"favicon.ico\", options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-favicon_link_tag", implicit_attribute: HelperImplicitAttribute.new( "href", "first_arg", nil, "image_path", ["url"] ), arguments: [ HelperArgument.new("source", 1, "string", true, "favicon.ico", false, "Path to the favicon file."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("type", "string", nil, "MIME type of the favicon (e.g. `\"image/x-icon\"`)."), HelperOption.new("rel", "string", nil, "Link relation (defaults to `\"icon\"`)."), ], special_behaviors: [], aliases: [], ).freeze
- IMAGE_DECODING =
: HelperEntry
HelperEntry.new( name: "image_decoding", type: HelperType::IMAGE_DECODING, source: "ActionView::Helpers::AssetTagHelper#image_decoding", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the default `decoding` attribute for `image_tag` (e.g. `\"async\"`).", signature: "image_decoding", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- IMAGE_LOADING =
: HelperEntry
HelperEntry.new( name: "image_loading", type: HelperType::IMAGE_LOADING, source: "ActionView::Helpers::AssetTagHelper#image_loading", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the default `loading` attribute for `image_tag` (e.g. `\"lazy\"`).", signature: "image_loading", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- IMAGE_TAG =
: HelperEntry
HelperEntry.new( name: "image_tag", type: HelperType::IMAGE_TAG, source: "ActionView::Helpers::AssetTagHelper#image_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "img", is_void: true, supports_block: false, preferred_for_tag: true, supported: true, detect_style: :call_name, description: "Returns an HTML `<img>` tag for the source. The source can be a full path, a file, or an Active Storage attachment. Options include `:size` (as `\"WxH\"` or `\"N\"`), `:srcset` (hash or array of [source, descriptor] pairs), and standard HTML attributes.", signature: "image_tag(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-image_tag", implicit_attribute: HelperImplicitAttribute.new( "src", "first_arg", nil, "image_path", ["url", "path_helper"] ), arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Image source path, URL, or Active Storage blob."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("alt", "string", nil, "Alt text for the image. Defaults to a humanized version of the filename."), HelperOption.new("size", "string", nil, "Image dimensions as `\"WxH\"` (e.g. `\"32x32\"`). Sets both width and height."), HelperOption.new("width", "string | integer", nil, "Image width in pixels."), HelperOption.new("height", "string | integer", nil, "Image height in pixels."), HelperOption.new("class", "string", nil, "CSS class name(s)."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [:size_to_dimensions, :remove_non_html_options], aliases: [], ).freeze
- JAVASCRIPT_INCLUDE_TAG =
: HelperEntry
HelperEntry.new( name: "javascript_include_tag", type: HelperType::JAVASCRIPT_INCLUDE_TAG, source: "ActionView::Helpers::AssetTagHelper#javascript_include_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "script", is_void: false, supports_block: false, preferred_for_tag: false, supported: true, detect_style: :call_name, description: "Returns an HTML `<script>` tag for each of the sources provided. Sources may be paths to JavaScript files. Relative paths are assumed to be relative to assets/javascripts. The `\".js\"` extension is optional unless `extname: false` is set.", signature: "javascript_include_tag(*sources)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-javascript_include_tag", implicit_attribute: HelperImplicitAttribute.new( "src", "first_arg", nil, "javascript_path", ["url"] ), arguments: [ HelperArgument.new("sources", 1, "string", false, nil, true, "One or more JavaScript file paths or URLs."), ], options: [ HelperOption.new("nonce", "boolean | string", nil, "CSP nonce value. When `true`, uses the Rails-generated nonce."), HelperOption.new("extname", "string | false", nil, "File extension to append. Defaults to `\".js\"`. Pass `false` to omit."), HelperOption.new("async", "boolean", nil, "Adds the `async` HTML attribute, allowing the script to be fetched in parallel."), HelperOption.new("defer", "boolean", nil, "Adds the `defer` HTML attribute, indicating the script should execute after the document has been parsed."), HelperOption.new("skip_pipeline", "boolean", nil, "Bypass the asset pipeline when set to `true`."), HelperOption.new("nopush", "boolean", nil, "Specify if the use of server push is not desired. Defaults to `true`."), ], special_behaviors: [:multiple_elements, :remove_non_html_options], aliases: [], ).freeze
- PICTURE_TAG =
: HelperEntry
HelperEntry.new( name: "picture_tag", type: HelperType::PICTURE_TAG, source: "ActionView::Helpers::AssetTagHelper#picture_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "picture", is_void: false, supports_block: true, preferred_for_tag: true, supported: false, detect_style: :call_name, description: "Returns an HTML `<picture>` tag for the sources. The last element provided will be used for the `<img>` tag. For complete control, a block can be passed which will populate the contents of the tag accordingly.", signature: "picture_tag(*sources, **options, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-picture_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("sources", 1, "string", false, nil, true, "One or more image sources for the picture element."), ], options: [ HelperOption.new("class", "string", nil, "CSS class name(s)."), ], special_behaviors: [], aliases: [], ).freeze
- PRELOAD_LINK_TAG =
: HelperEntry
HelperEntry.new( name: "preload_link_tag", type: HelperType::PRELOAD_LINK_TAG, source: "ActionView::Helpers::AssetTagHelper#preload_link_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "link", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<link>` tag that browsers can use to preload the source. The source can be the path of a resource managed by asset pipeline, a full path, or a URI. Automatically sets the `as` and `type` attributes based on the file extension.", signature: "preload_link_tag(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-preload_link_tag", implicit_attribute: HelperImplicitAttribute.new( "href", "first_arg", nil, "asset_path", ["url"] ), arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Asset source path or URL to preload."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("as", "string", nil, "Resource type (e.g. `\"script\"`, `\"style\"`, `\"font\"`)."), HelperOption.new("type", "string", nil, "MIME type of the resource."), HelperOption.new("crossorigin", "string | boolean", nil, "CORS setting for the preload request."), HelperOption.new("nonce", "boolean | string", nil, "CSP nonce value."), ], special_behaviors: [], aliases: [], ).freeze
- PRELOAD_LINKS_HEADER =
: HelperEntry
HelperEntry.new( name: "preload_links_header", type: HelperType::PRELOAD_LINKS_HEADER, source: "ActionView::Helpers::AssetTagHelper#preload_links_header", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether asset tags send HTTP Early Hints preload link headers.", signature: "preload_links_header", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- STYLESHEET_LINK_TAG =
: HelperEntry
HelperEntry.new( name: "stylesheet_link_tag", type: HelperType::STYLESHEET_LINK_TAG, source: "ActionView::Helpers::AssetTagHelper#stylesheet_link_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "link", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a stylesheet `<link>` tag for the sources specified as arguments. The .css extension is optional. If the server supports HTTP Early Hints, Rails will push a 103 Early Hints response that links to the assets.", signature: "stylesheet_link_tag(*sources)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-stylesheet_link_tag", implicit_attribute: HelperImplicitAttribute.new( "href", "first_arg", nil, "stylesheet_path", ["url"] ), arguments: [ HelperArgument.new("sources", 1, "string", false, nil, true, "One or more stylesheet file paths or URLs."), ], options: [ HelperOption.new("media", "string", nil, "Media type for the stylesheet (e.g. `\"screen\"`, `\"print\"`)."), HelperOption.new("nonce", "boolean | string", nil, "CSP nonce value."), HelperOption.new("extname", "string | false", nil, "File extension to append. Defaults to `\".css\"`."), HelperOption.new("skip_pipeline", "boolean", nil, "Bypass the asset pipeline when set to `true`."), HelperOption.new("nopush", "boolean", nil, "Specify if the use of server push is not desired. Defaults to `true`."), ], special_behaviors: [:multiple_sources_multiple_elements], aliases: [], ).freeze
- VIDEO_TAG =
: HelperEntry
HelperEntry.new( name: "video_tag", type: HelperType::VIDEO_TAG, source: "ActionView::Helpers::AssetTagHelper#video_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "video", is_void: false, supports_block: true, preferred_for_tag: true, supported: false, detect_style: :call_name, description: "Returns an HTML `<video>` tag for the sources. If sources is a string, a single `<video>` tag will be returned. If sources is an array, a `<video>` tag with nested `<source>` tags for each source will be returned. The sources can be full paths, files in your public videos directory, or Active Storage attachments.", signature: "video_tag(*sources, **options)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-video_tag", implicit_attribute: HelperImplicitAttribute.new( "src", "first_arg", nil, "video_path", ["url"] ), arguments: [ HelperArgument.new("sources", 1, "string", false, nil, true, "One or more video file paths or URLs."), ], options: [ HelperOption.new("poster", "string", nil, "Image to display before video plays."), HelperOption.new("size", "string", nil, "Video dimensions as `\"WxH\"`."), HelperOption.new("controls", "boolean", nil, "Whether to show playback controls."), HelperOption.new("autoplay", "boolean", nil, "Whether to start playing automatically."), HelperOption.new("muted", "boolean", nil, "Whether video is muted."), HelperOption.new("loop", "boolean", nil, "Whether video loops."), HelperOption.new("preload", "string", nil, "Preload behavior (`\"auto\"`, `\"metadata\"`, `\"none\"`)."), ], special_behaviors: [], aliases: [], ).freeze
- ASSET_PATH =
: HelperEntry
HelperEntry.new( name: "asset_path", type: HelperType::ASSET_PATH, source: "ActionView::Helpers::AssetUrlHelper#asset_path", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the path to an asset in the public assets directory.", signature: "asset_path(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_path", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Asset file name or path."), ], options: [ ], special_behaviors: [], aliases: ["path_to_asset"], ).freeze
- ASSET_URL =
: HelperEntry
HelperEntry.new( name: "asset_url", type: HelperType::ASSET_URL, source: "ActionView::Helpers::AssetUrlHelper#asset_url", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the full URL to an asset in the public assets directory.", signature: "asset_url(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_url", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Asset file name or path."), ], options: [ ], special_behaviors: [], aliases: ["url_to_asset"], ).freeze
- AUDIO_PATH =
: HelperEntry
HelperEntry.new( name: "audio_path", type: HelperType::AUDIO_PATH, source: "ActionView::Helpers::AssetUrlHelper#audio_path", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the path to an audio asset.", signature: "audio_path(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-audio_path", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Audio file name or path."), ], options: [ ], special_behaviors: [], aliases: ["path_to_audio"], ).freeze
- AUDIO_URL =
: HelperEntry
HelperEntry.new( name: "audio_url", type: HelperType::AUDIO_URL, source: "ActionView::Helpers::AssetUrlHelper#audio_url", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the full URL to an audio asset.", signature: "audio_url(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-audio_url", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Audio file name or path."), ], options: [ ], special_behaviors: [], aliases: ["url_to_audio"], ).freeze
- COMPUTE_ASSET_EXTNAME =
: HelperEntry
HelperEntry.new( name: "compute_asset_extname", type: HelperType::COMPUTE_ASSET_EXTNAME, source: "ActionView::Helpers::AssetUrlHelper#compute_asset_extname", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the file extension to append to asset paths based on the MIME type.", signature: "compute_asset_extname(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-compute_asset_extname", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- COMPUTE_ASSET_HOST =
: HelperEntry
HelperEntry.new( name: "compute_asset_host", type: HelperType::COMPUTE_ASSET_HOST, source: "ActionView::Helpers::AssetUrlHelper#compute_asset_host", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the asset host for serving assets from a CDN or asset-specific subdomain.", signature: "compute_asset_host(source = \"\", options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-compute_asset_host", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- COMPUTE_ASSET_PATH =
: HelperEntry
HelperEntry.new( name: "compute_asset_path", type: HelperType::COMPUTE_ASSET_PATH, source: "ActionView::Helpers::AssetUrlHelper#compute_asset_path", gem: "actionview", output: :url, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the full asset path for a given source file, applying the asset pipeline prefix.", signature: "compute_asset_path(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-compute_asset_path", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FONT_PATH =
: HelperEntry
HelperEntry.new( name: "font_path", type: HelperType::FONT_PATH, source: "ActionView::Helpers::AssetUrlHelper#font_path", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the path to a font asset.", signature: "font_path(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-font_path", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Font file name or path."), ], options: [ ], special_behaviors: [], aliases: ["path_to_font"], ).freeze
- FONT_URL =
: HelperEntry
HelperEntry.new( name: "font_url", type: HelperType::FONT_URL, source: "ActionView::Helpers::AssetUrlHelper#font_url", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the full URL to a font asset.", signature: "font_url(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-font_url", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Font file name or path."), ], options: [ ], special_behaviors: [], aliases: ["url_to_font"], ).freeze
- IMAGE_PATH =
: HelperEntry
HelperEntry.new( name: "image_path", type: HelperType::IMAGE_PATH, source: "ActionView::Helpers::AssetUrlHelper#image_path", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the path to an image asset.", signature: "image_path(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-image_path", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Image file name or path."), ], options: [ ], special_behaviors: [], aliases: ["path_to_image"], ).freeze
- IMAGE_URL =
: HelperEntry
HelperEntry.new( name: "image_url", type: HelperType::IMAGE_URL, source: "ActionView::Helpers::AssetUrlHelper#image_url", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the full URL to an image asset.", signature: "image_url(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-image_url", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Image file name or path."), ], options: [ ], special_behaviors: [], aliases: ["url_to_image"], ).freeze
- JAVASCRIPT_PATH =
: HelperEntry
HelperEntry.new( name: "javascript_path", type: HelperType::JAVASCRIPT_PATH, source: "ActionView::Helpers::AssetUrlHelper#javascript_path", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the path to a JavaScript asset.", signature: "javascript_path(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-javascript_path", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "JavaScript file name or path."), ], options: [ ], special_behaviors: [], aliases: ["path_to_javascript"], ).freeze
- JAVASCRIPT_URL =
: HelperEntry
HelperEntry.new( name: "javascript_url", type: HelperType::JAVASCRIPT_URL, source: "ActionView::Helpers::AssetUrlHelper#javascript_url", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the full URL to a JavaScript asset.", signature: "javascript_url(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-javascript_url", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "JavaScript file name or path."), ], options: [ ], special_behaviors: [], aliases: ["url_to_javascript"], ).freeze
- PUBLIC_COMPUTE_ASSET_PATH =
: HelperEntry
HelperEntry.new( name: "public_compute_asset_path", type: HelperType::PUBLIC_COMPUTE_ASSET_PATH, source: "ActionView::Helpers::AssetUrlHelper#public_compute_asset_path", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Public alias for `compute_asset_path`. Computes the full asset path for a given source.", signature: "public_compute_asset_path", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- STYLESHEET_PATH =
: HelperEntry
HelperEntry.new( name: "stylesheet_path", type: HelperType::STYLESHEET_PATH, source: "ActionView::Helpers::AssetUrlHelper#stylesheet_path", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the path to a stylesheet asset.", signature: "stylesheet_path(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-stylesheet_path", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Stylesheet file name or path."), ], options: [ ], special_behaviors: [], aliases: ["path_to_stylesheet"], ).freeze
- STYLESHEET_URL =
: HelperEntry
HelperEntry.new( name: "stylesheet_url", type: HelperType::STYLESHEET_URL, source: "ActionView::Helpers::AssetUrlHelper#stylesheet_url", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the full URL to a stylesheet asset.", signature: "stylesheet_url(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-stylesheet_url", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Stylesheet file name or path."), ], options: [ ], special_behaviors: [], aliases: ["url_to_stylesheet"], ).freeze
- VIDEO_PATH =
: HelperEntry
HelperEntry.new( name: "video_path", type: HelperType::VIDEO_PATH, source: "ActionView::Helpers::AssetUrlHelper#video_path", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the path to a video asset.", signature: "video_path(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-video_path", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Video file name or path."), ], options: [ ], special_behaviors: [], aliases: ["path_to_video"], ).freeze
- VIDEO_URL =
: HelperEntry
HelperEntry.new( name: "video_url", type: HelperType::VIDEO_URL, source: "ActionView::Helpers::AssetUrlHelper#video_url", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Computes the full URL to a video asset.", signature: "video_url(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-video_url", implicit_attribute: nil, arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Video file name or path."), ], options: [ ], special_behaviors: [], aliases: ["url_to_video"], ).freeze
- ATOM_FEED =
: HelperEntry
HelperEntry.new( name: "atom_feed", type: HelperType::ATOM_FEED, source: "ActionView::Helpers::AtomFeedHelper#atom_feed", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an Atom feed using the Builder template engine. Yields an `AtomFeedBuilder` instance to the block. This helper is designed for use in `.atom.builder` templates, not ERB.", signature: "atom_feed(options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/AtomFeedHelper.html#method-i-atom_feed", implicit_attribute: nil, arguments: [ HelperArgument.new("options", 1, "hash", true, "{}", false, "Feed options hash."), ], options: [ HelperOption.new("language", "string", nil, "Feed language. Defaults to `\"en-US\"`."), HelperOption.new("root_url", "string", nil, "The HTML alternative URL for the feed."), HelperOption.new("url", "string", nil, "The URL for this feed. Defaults to the current URL."), HelperOption.new("id", "string", nil, "The id for this feed."), HelperOption.new("schema_date", "string", nil, "The date at which the tag scheme for the feed was first used. Defaults to `\"2005\"`."), HelperOption.new("instruct", "hash", nil, "Hash of XML processing instructions."), ], special_behaviors: [], aliases: [], ).freeze
- CACHE =
: HelperEntry
HelperEntry.new( name: "cache", type: HelperType::CACHE, source: "ActionView::Helpers::CacheHelper#cache", gem: "actionview", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Caches fragments of a view rather than an entire action or page.", signature: "cache(name = {}, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html#method-i-cache", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string | hash | object", true, "{}", false, "Cache key."), ], options: [ HelperOption.new("skip_digest", "boolean", nil, "If `true`, skips template digest in cache key."), HelperOption.new("expires_in", "integer", nil, "Cache expiration time."), ], special_behaviors: [], aliases: [], ).freeze
- CACHE_FRAGMENT_NAME =
: HelperEntry
HelperEntry.new( name: "cache_fragment_name", type: HelperType::CACHE_FRAGMENT_NAME, source: "ActionView::Helpers::CacheHelper#cache_fragment_name", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the cache key name for a fragment cache entry, applying the template digest if applicable.", signature: "cache_fragment_name(name = {}, skip_digest: nil, digest_path: nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html#method-i-cache_fragment_name", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CACHE_IF =
: HelperEntry
HelperEntry.new( name: "cache_if", type: HelperType::CACHE_IF, source: "ActionView::Helpers::CacheHelper#cache_if", gem: "actionview", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Cache fragments of a view if condition is true.", signature: "cache_if(condition, name = {}, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html#method-i-cache_if", implicit_attribute: nil, arguments: [ HelperArgument.new("condition", 1, "boolean", false, nil, false, "Condition to evaluate."), HelperArgument.new("name", 2, "string | hash | object", true, "{}", false, "Cache key."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CACHE_UNLESS =
: HelperEntry
HelperEntry.new( name: "cache_unless", type: HelperType::CACHE_UNLESS, source: "ActionView::Helpers::CacheHelper#cache_unless", gem: "actionview", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Cache fragments of a view unless condition is true.", signature: "cache_unless(condition, name = {}, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html#method-i-cache_unless", implicit_attribute: nil, arguments: [ HelperArgument.new("condition", 1, "boolean", false, nil, false, "Condition to evaluate."), HelperArgument.new("name", 2, "string | hash | object", true, "{}", false, "Cache key."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CACHING_P =
: HelperEntry
HelperEntry.new( name: "caching?", type: HelperType::CACHING_P, source: "ActionView::Helpers::CacheHelper#caching?", gem: "actionview", output: :boolean, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether the current view is inside a `cache` block.", signature: "caching?", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html#method-i-caching-3F", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- DIGEST_PATH_FROM_TEMPLATE =
: HelperEntry
HelperEntry.new( name: "digest_path_from_template", type: HelperType::DIGEST_PATH_FROM_TEMPLATE, source: "ActionView::Helpers::CacheHelper#digest_path_from_template", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the digest path used for cache key generation from the current template.", signature: "digest_path_from_template(template)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FRAGMENT_FOR =
: HelperEntry
HelperEntry.new( name: "fragment_for", type: HelperType::FRAGMENT_FOR, source: "ActionView::Helpers::CacheHelper#fragment_for", gem: "actionview", output: :html, visibility: "internal", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Reads or writes a fragment cache entry, yielding to the block on cache miss.", signature: "fragment_for(name = {}, options = {}, &block)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FRAGMENT_NAME_WITH_DIGEST =
: HelperEntry
HelperEntry.new( name: "fragment_name_with_digest", type: HelperType::FRAGMENT_NAME_WITH_DIGEST, source: "ActionView::Helpers::CacheHelper#fragment_name_with_digest", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the fragment cache name with the template digest appended for cache busting.", signature: "fragment_name_with_digest(name, digest_path)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- READ_FRAGMENT_FOR =
: HelperEntry
HelperEntry.new( name: "read_fragment_for", type: HelperType::READ_FRAGMENT_FOR, source: "ActionView::Helpers::CacheHelper#read_fragment_for", gem: "actionview", output: :html, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Reads a cached fragment from the cache store. Returns `nil` on cache miss.", signature: "read_fragment_for(name, options)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- UNCACHEABLE_BANG =
: HelperEntry
HelperEntry.new( name: "uncacheable!", type: HelperType::UNCACHEABLE_BANG, source: "ActionView::Helpers::CacheHelper#uncacheable!", gem: "actionview", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Raises `UncacheableFragmentError` when called from within a `cache` block. Use to prevent certain content from being fragment cached.", signature: "uncacheable!", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html#method-i-uncacheable-21", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- WRITE_FRAGMENT_FOR =
: HelperEntry
HelperEntry.new( name: "write_fragment_for", type: HelperType::WRITE_FRAGMENT_FOR, source: "ActionView::Helpers::CacheHelper#write_fragment_for", gem: "actionview", output: :html, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Writes a fragment to the cache store.", signature: "write_fragment_for(name, fragment, options)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CAPTURE =
: HelperEntry
HelperEntry.new( name: "capture", type: HelperType::CAPTURE, source: "ActionView::Helpers::CaptureHelper#capture", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Extracts a part of a template as a string object. Useful for capturing markup for later use.", signature: "capture(*, **, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CaptureHelper.html#method-i-capture", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CONTENT_FOR =
: HelperEntry
HelperEntry.new( name: "content_for", type: HelperType::CONTENT_FOR, source: "ActionView::Helpers::CaptureHelper#content_for", gem: "actionview", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Stores a block of markup in an identifier for later use. Call `content_for` with the same identifier to retrieve stored content.", signature: "content_for(name, content = nil, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CaptureHelper.html#method-i-content_for", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "symbol", false, nil, false, "Identifier for the content block."), ], options: [ HelperOption.new("flush", "boolean", nil, "If `true`, replaces any existing content instead of appending."), ], special_behaviors: [], aliases: [], ).freeze
- CONTENT_FOR_P =
: HelperEntry
HelperEntry.new( name: "content_for?", type: HelperType::CONTENT_FOR_P, source: "ActionView::Helpers::CaptureHelper#content_for?", gem: "actionview", output: :boolean, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Checks whether any content has been captured yet using `content_for`. Useful in layouts to conditionally render sections.", signature: "content_for?(name)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CaptureHelper.html#method-i-content_for-3F", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "symbol", false, nil, false, "Identifier for the content block to check."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- PROVIDE =
: HelperEntry
HelperEntry.new( name: "provide", type: HelperType::PROVIDE, source: "ActionView::Helpers::CaptureHelper#provide", gem: "actionview", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Same as `content_for` but flushes content straight back to the layout. Use this in streaming scenarios.", signature: "provide(name, content = nil, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CaptureHelper.html#method-i-provide", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "symbol", false, nil, false, "Identifier for the content block."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- WITH_OUTPUT_BUFFER =
: HelperEntry
HelperEntry.new( name: "with_output_buffer", type: HelperType::WITH_OUTPUT_BUFFER, source: "ActionView::Helpers::CaptureHelper#with_output_buffer", gem: "actionview", output: :html, visibility: "internal", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Swaps the output buffer for the duration of the block and returns the captured content as a string.", signature: "with_output_buffer(buf = nil, &block)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- PREPEND_CONTENT_EXFILTRATION_PREVENTION =
: HelperEntry
HelperEntry.new( name: "prepend_content_exfiltration_prevention", type: HelperType::PREPEND_CONTENT_EXFILTRATION_PREVENTION, source: "ActionView::Helpers::ContentExfiltrationPreventionHelper#prepend_content_exfiltration_prevention", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether content exfiltration prevention markup is prepended to HTML output.", signature: "prepend_content_exfiltration_prevention", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/ContentExfiltrationPreventionHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- PREVENT_CONTENT_EXFILTRATION =
: HelperEntry
HelperEntry.new( name: "prevent_content_exfiltration", type: HelperType::PREVENT_CONTENT_EXFILTRATION, source: "ActionView::Helpers::ContentExfiltrationPreventionHelper#prevent_content_exfiltration", gem: "actionview", output: :html, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Prepends security markup to HTML output to prevent content exfiltration via dangling markup injection attacks.", signature: "prevent_content_exfiltration(html)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/ContentExfiltrationPreventionHelper.html#method-i-prevent_content_exfiltration", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- ACTION_NAME =
: HelperEntry
HelperEntry.new( name: "action_name", type: HelperType::ACTION_NAME, source: "ActionView::Helpers::ControllerHelper#action_name", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the name of the current controller action as a string. Delegated to the controller.", signature: "action_name", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- ASSIGN_CONTROLLER =
: HelperEntry
HelperEntry.new( name: "assign_controller", type: HelperType::ASSIGN_CONTROLLER, source: "ActionView::Helpers::ControllerHelper#assign_controller", gem: "actionview", output: :void, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Assigns the controller instance to the view context. Called internally during rendering setup.", signature: "assign_controller(controller)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CONTROLLER =
: HelperEntry
HelperEntry.new( name: "controller", type: HelperType::CONTROLLER, source: "ActionView::Helpers::ControllerHelper#controller", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the current controller instance. Delegated from `ActionView::Helpers::ControllerHelper`.", signature: "controller", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CONTROLLER_NAME =
: HelperEntry
HelperEntry.new( name: "controller_name", type: HelperType::CONTROLLER_NAME, source: "ActionView::Helpers::ControllerHelper#controller_name", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the name of the current controller without the namespace. Delegated to the controller.", signature: "controller_name", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CONTROLLER_PATH =
: HelperEntry
HelperEntry.new( name: "controller_path", type: HelperType::CONTROLLER_PATH, source: "ActionView::Helpers::ControllerHelper#controller_path", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the full path of the current controller including namespace. Delegated to the controller.", signature: "controller_path", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- COOKIES =
: HelperEntry
HelperEntry.new( name: "cookies", type: HelperType::COOKIES, source: "ActionView::Helpers::ControllerHelper#cookies", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the cookies for the current request. Delegated to the controller. See `ActionDispatch::Cookies`.", signature: "cookies", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FLASH =
: HelperEntry
HelperEntry.new( name: "flash", type: HelperType::FLASH, source: "ActionView::Helpers::ControllerHelper#flash", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the flash messages hash. Access `flash[:notice]`, `flash[:alert]`, etc. Delegated to the controller.", signature: "flash", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- HEADERS =
: HelperEntry
HelperEntry.new( name: "headers", type: HelperType::HEADERS, source: "ActionView::Helpers::ControllerHelper#headers", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the response headers hash. Delegated to the controller.", signature: "headers", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- LOGGER =
: HelperEntry
HelperEntry.new( name: "logger", type: HelperType::LOGGER, source: "ActionView::Helpers::ControllerHelper#logger", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the logger instance from the controller.", signature: "logger", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: ["logger?"], ).freeze
- PARAMS =
: HelperEntry
HelperEntry.new( name: "params", type: HelperType::PARAMS, source: "ActionView::Helpers::ControllerHelper#params", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the request parameters as an `ActionController::Parameters` object. Delegated to the controller.", signature: "params", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- REQUEST =
: HelperEntry
HelperEntry.new( name: "request", type: HelperType::REQUEST, source: "ActionView::Helpers::ControllerHelper#request", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the current `ActionDispatch::Request` object. Delegated from `ActionView::Helpers::ControllerHelper`.", signature: "request", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- REQUEST_FORGERY_PROTECTION_TOKEN =
: HelperEntry
HelperEntry.new( name: "request_forgery_protection_token", type: HelperType::REQUEST_FORGERY_PROTECTION_TOKEN, source: "ActionView::Helpers::ControllerHelper#request_forgery_protection_token", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the token parameter name used for CSRF protection. Delegated to the controller.", signature: "request_forgery_protection_token", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- RESPONSE =
: HelperEntry
HelperEntry.new( name: "response", type: HelperType::RESPONSE, source: "ActionView::Helpers::ControllerHelper#response", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the current `ActionDispatch::Response` object. Delegated to the controller.", signature: "response", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SESSION =
: HelperEntry
HelperEntry.new( name: "session", type: HelperType::SESSION, source: "ActionView::Helpers::ControllerHelper#session", gem: "actionview", output: :object, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the current session hash. Delegated to the controller.", signature: "session", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CSP_META_TAG =
: HelperEntry
HelperEntry.new( name: "csp_meta_tag", type: HelperType::CSP_META_TAG, source: "ActionView::Helpers::CspHelper#csp_meta_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "meta", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<meta>` tag `\"csp-nonce\"` with the per-session nonce value for allowing inline `<script>` tags. Used by the Rails UJS helper to create dynamically loaded inline `<script>` elements.", signature: "csp_meta_tag(**options)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CspHelper.html#method-i-csp_meta_tag", implicit_attribute: nil, arguments: [ ], options: [ HelperOption.new("nonce", "string", nil, "CSP nonce value."), ], special_behaviors: [], aliases: [], ).freeze
- CSRF_META_TAGS =
: HelperEntry
HelperEntry.new( name: "csrf_meta_tags", type: HelperType::CSRF_META_TAGS, source: "ActionView::Helpers::CsrfHelper#csrf_meta_tags", gem: "actionview", output: :html, visibility: "public", tag_name: "meta", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns `<meta>` tags `\"csrf-param\"` and `\"csrf-token\"` with the name of the cross-site request forgery protection parameter and token, respectively. These are used to generate dynamic forms that implement non-remote links with `:method`. Not needed for regular forms as they generate their own hidden fields.", signature: "csrf_meta_tags", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/CsrfHelper.html#method-i-csrf_meta_tags", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [:produces_multiple_elements], aliases: ["csrf_meta_tag"], ).freeze
- DATE_SELECT =
: HelperEntry
HelperEntry.new( name: "date_select", type: HelperType::DATE_SELECT, source: "ActionView::Helpers::DateHelper#date_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a set of `<select>` tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute (identified by `method`) on an object assigned to the template (identified by `object`).", signature: "date_select(object_name, method, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-date_select", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "string", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options for customizing the date select behavior."), HelperArgument.new("html_options", 4, "hash", true, "{}", false, "HTML attributes applied to every `<select>` tag in the set."), ], options: [ HelperOption.new("order", "array", nil, "Array containing `:day`, `:month`, and `:year` to customize the order of select fields."), HelperOption.new("include_blank", "boolean", nil, "Include a blank option in every select field."), HelperOption.new("discard_day", "boolean", nil, "If `true`, the day select is replaced with a hidden field."), HelperOption.new("discard_month", "boolean", nil, "If `true`, the month select is replaced with a hidden field."), HelperOption.new("discard_year", "boolean", nil, "If `true`, the year select is replaced with a hidden field."), HelperOption.new("start_year", "integer", nil, "The start year for the year select."), HelperOption.new("end_year", "integer", nil, "The end year for the year select."), HelperOption.new("prompt", "boolean | string | hash", nil, "Set to `true` for generic prompts, a string for a custom prompt, or a hash for per-field prompts."), HelperOption.new("selected", "date", nil, "A date that overrides the actual value."), HelperOption.new("default", "date | hash", nil, "Set a default date if the affected date is not set or is `nil`."), HelperOption.new("disabled", "boolean", nil, "If `true`, the select fields are disabled."), ], special_behaviors: [], aliases: [], ).freeze
- DATETIME_SELECT =
: HelperEntry
HelperEntry.new( name: "datetime_select", type: HelperType::DATETIME_SELECT, source: "ActionView::Helpers::DateHelper#datetime_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a set of `<select>` tags (one for year, month, day, hour, and minute) pre-selected for accessing a specified datetime-based attribute (identified by `method`) on an object assigned to the template (identified by `object`).", signature: "datetime_select(object_name, method, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-datetime_select", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "string", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options for customizing the datetime select behavior."), HelperArgument.new("html_options", 4, "hash", true, "{}", false, "HTML attributes applied to every `<select>` tag in the set."), ], options: [ HelperOption.new("start_year", "integer", nil, "The start year for the year select."), HelperOption.new("end_year", "integer", nil, "The end year for the year select."), HelperOption.new("ampm", "boolean", nil, "If `true`, shows hours in AM/PM format."), HelperOption.new("discard_type", "boolean", nil, "If `true`, discards the type part of the select name."), HelperOption.new("prompt", "boolean | string | hash", nil, "Set to `true` for generic prompts, a string for a custom prompt, or a hash for per-field prompts."), HelperOption.new("default", "datetime | hash", nil, "Set a default datetime if the affected datetime is not set or is `nil`."), HelperOption.new("disabled", "boolean", nil, "If `true`, the select fields are disabled."), ], special_behaviors: [], aliases: [], ).freeze
- DISTANCE_OF_TIME_IN_WORDS =
: HelperEntry
HelperEntry.new( name: "distance_of_time_in_words", type: HelperType::DISTANCE_OF_TIME_IN_WORDS, source: "ActionView::Helpers::DateHelper#distance_of_time_in_words", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Reports the approximate distance in time between two Time, Date, or DateTime objects or integers as seconds.", signature: "distance_of_time_in_words(from_time, to_time = 0, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-distance_of_time_in_words", implicit_attribute: nil, arguments: [ HelperArgument.new("from_time", 1, "object", false, nil, false, "Starting time."), HelperArgument.new("to_time", 2, "object", true, "0", false, "Ending time. Defaults to now."), ], options: [ HelperOption.new("include_seconds", "boolean", nil, "Include more detail for distances under 1 minute."), HelperOption.new("scope", "string", nil, "I18n scope for translations."), ], special_behaviors: [], aliases: [], ).freeze
- RELATIVE_TIME_IN_WORDS =
: HelperEntry
HelperEntry.new( name: "relative_time_in_words", type: HelperType::RELATIVE_TIME_IN_WORDS, source: "ActionView::Helpers::DateHelper#relative_time_in_words", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Like `time_ago_in_words`, but adds a prefix or suffix depending on whether the time is in the past or future. You can use the `:scope` option to customize the translation scope. All other options are forwarded to `time_ago_in_words`.", signature: "relative_time_in_words(from_time, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-relative_time_in_words", implicit_attribute: nil, arguments: [ HelperArgument.new("from_time", 1, "time | date | datetime", false, nil, false, "The time to compare against the current time."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options forwarded to `time_ago_in_words`."), ], options: [ HelperOption.new("scope", "string", nil, "Custom I18n translation scope."), HelperOption.new("include_seconds", "boolean", nil, "If `true`, provides more detailed approximations when the distance is less than 1 minute 29 seconds."), HelperOption.new("locale", "symbol", nil, "Locale for the translation."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_DATE =
: HelperEntry
HelperEntry.new( name: "select_date", type: HelperType::SELECT_DATE, source: "ActionView::Helpers::DateHelper#select_date", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a set of HTML `<select>` tags (one for year, month, and day) pre-selected with the `date`. It is possible to explicitly set the order of the tags using the `:order` option with an array of symbols `:year`, `:month`, and `:day` in the desired order.", signature: "select_date(date = Date.current, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_date", implicit_attribute: nil, arguments: [ HelperArgument.new("date", 1, "date | time", true, "Date.current", false, "The date to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the date select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes applied to every `<select>` tag in the set."), ], options: [ HelperOption.new("order", "array", nil, "Array containing `:year`, `:month`, and `:day` to customize the order of select fields."), HelperOption.new("date_separator", "string", nil, "String to separate the date fields."), HelperOption.new("discard_type", "boolean", nil, "If `true`, discards the type part of the select name."), HelperOption.new("prefix", "string", nil, "Overwrites the default prefix of `\"date\"` used for the select names."), HelperOption.new("prompt", "boolean | string | hash", nil, "Set to `true` for generic prompts, a string for a custom prompt, or a hash for per-field prompts."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_DATETIME =
: HelperEntry
HelperEntry.new( name: "select_datetime", type: HelperType::SELECT_DATETIME, source: "ActionView::Helpers::DateHelper#select_datetime", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a set of HTML `<select>` tags (one for year, month, day, hour, minute, and second) pre-selected with the `datetime`. It is possible to explicitly set the order of the tags using the `:order` option with an array of symbols `:year`, `:month`, and `:day` in the desired order.", signature: "select_datetime(datetime = Time.current, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_datetime", implicit_attribute: nil, arguments: [ HelperArgument.new("datetime", 1, "time | datetime", true, "Time.current", false, "The datetime to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the datetime select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes applied to every `<select>` tag in the set."), ], options: [ HelperOption.new("order", "array", nil, "Array containing `:year`, `:month`, and `:day` to customize the order of select fields."), HelperOption.new("date_separator", "string", nil, "String to separate the date fields."), HelperOption.new("time_separator", "string", nil, "String to separate the time fields."), HelperOption.new("datetime_separator", "string", nil, "String to separate the date and time fields."), HelperOption.new("discard_type", "boolean", nil, "If `true`, discards the type part of the select name."), HelperOption.new("ampm", "boolean", nil, "If `true`, shows hours in AM/PM format."), HelperOption.new("prefix", "string", nil, "Overwrites the default prefix of `\"date\"` used for the select names."), HelperOption.new("prompt", "boolean | string | hash", nil, "Set to `true` for generic prompts, a string for a custom prompt, or a hash for per-field prompts."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_DAY =
: HelperEntry
HelperEntry.new( name: "select_day", type: HelperType::SELECT_DAY, source: "ActionView::Helpers::DateHelper#select_day", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<select>` tag with options for each of the days 1 through 31 with the current day selected. The `date` can also be substituted for a day number. If you want to display days with a leading zero set the `:use_two_digit_numbers` key in options to `true`. Override the field name using the `:field_name` option, `\"day\"` by default.", signature: "select_day(date, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_day", implicit_attribute: nil, arguments: [ HelperArgument.new("date", 1, "date | time | integer", false, nil, false, "The date, time, or day number to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the day select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("field_name", "string", nil, "Override the field name, defaults to `\"day\"`."), HelperOption.new("use_two_digit_numbers", "boolean", nil, "If `true`, displays days with a leading zero."), HelperOption.new("prompt", "boolean | string", nil, "Set to `true` for a generic prompt or a string for a custom prompt."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_HOUR =
: HelperEntry
HelperEntry.new( name: "select_hour", type: HelperType::SELECT_HOUR, source: "ActionView::Helpers::DateHelper#select_hour", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<select>` tag with options for each of the hours 0 through 23 with the current hour selected. The `datetime` can be either a `Time` or `DateTime` object or an integer. Override the field name using the `:field_name` option, `\"hour\"` by default.", signature: "select_hour(datetime, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_hour", implicit_attribute: nil, arguments: [ HelperArgument.new("datetime", 1, "time | datetime | integer", false, nil, false, "The time, datetime, or integer to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the hour select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("field_name", "string", nil, "Override the field name, defaults to `\"hour\"`."), HelperOption.new("ampm", "boolean", nil, "If `true`, shows hours in AM/PM format."), HelperOption.new("start_hour", "integer", nil, "The starting hour for the hour select."), HelperOption.new("end_hour", "integer", nil, "The ending hour for the hour select."), HelperOption.new("prompt", "boolean | string", nil, "Set to `true` for a generic prompt or a string for a custom prompt."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_MINUTE =
: HelperEntry
HelperEntry.new( name: "select_minute", type: HelperType::SELECT_MINUTE, source: "ActionView::Helpers::DateHelper#select_minute", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<select>` tag with options for each of the minutes 0 through 59 with the current minute selected. Also can return a select tag with options by `minute_step` from 0 through 59 with the 00 minute selected. The `datetime` can be either a `Time` or `DateTime` object or an integer. Override the field name using the `:field_name` option, `\"minute\"` by default.", signature: "select_minute(datetime, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_minute", implicit_attribute: nil, arguments: [ HelperArgument.new("datetime", 1, "time | datetime | integer", false, nil, false, "The time, datetime, or integer to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the minute select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("field_name", "string", nil, "Override the field name, defaults to `\"minute\"`."), HelperOption.new("minute_step", "integer", nil, "Step value for the minute select."), HelperOption.new("prompt", "boolean | string", nil, "Set to `true` for a generic prompt or a string for a custom prompt."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_MONTH =
: HelperEntry
HelperEntry.new( name: "select_month", type: HelperType::SELECT_MONTH, source: "ActionView::Helpers::DateHelper#select_month", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<select>` tag with options for each of the months January through December with the current month selected. The month names are presented as keys and the month numbers (1-12) are used as values. Override the field name using the `:field_name` option, `\"month\"` by default.", signature: "select_month(date, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_month", implicit_attribute: nil, arguments: [ HelperArgument.new("date", 1, "date | time | integer", false, nil, false, "The date, time, or month number to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the month select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("field_name", "string", nil, "Override the field name, defaults to `\"month\"`."), HelperOption.new("use_month_numbers", "boolean", nil, "If `true`, uses month numbers rather than month names."), HelperOption.new("use_two_digit_numbers", "boolean", nil, "If `true`, displays months with a leading zero."), HelperOption.new("add_month_numbers", "boolean", nil, "If `true`, uses both month numbers and month names."), HelperOption.new("use_short_month", "boolean", nil, "If `true`, uses abbreviated month names."), HelperOption.new("use_month_names", "array", nil, "An array of 12 custom month names."), HelperOption.new("prompt", "boolean | string", nil, "Set to `true` for a generic prompt or a string for a custom prompt."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_SECOND =
: HelperEntry
HelperEntry.new( name: "select_second", type: HelperType::SELECT_SECOND, source: "ActionView::Helpers::DateHelper#select_second", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<select>` tag with options for each of the seconds 0 through 59 with the current second selected. The `datetime` can be either a `Time` or `DateTime` object or an integer. Override the field name using the `:field_name` option, `\"second\"` by default.", signature: "select_second(datetime, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_second", implicit_attribute: nil, arguments: [ HelperArgument.new("datetime", 1, "time | datetime | integer", false, nil, false, "The time, datetime, or integer to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the second select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("field_name", "string", nil, "Override the field name, defaults to `\"second\"`."), HelperOption.new("prompt", "boolean | string", nil, "Set to `true` for a generic prompt or a string for a custom prompt."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_TIME =
: HelperEntry
HelperEntry.new( name: "select_time", type: HelperType::SELECT_TIME, source: "ActionView::Helpers::DateHelper#select_time", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a set of HTML `<select>` tags (one for hour and minute). You can set `:time_separator` to format the output, and the `:include_seconds` option to include an input for seconds.", signature: "select_time(datetime = Time.current, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_time", implicit_attribute: nil, arguments: [ HelperArgument.new("datetime", 1, "time | datetime", true, "Time.current", false, "The time to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the time select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes applied to every `<select>` tag in the set."), ], options: [ HelperOption.new("time_separator", "string", nil, "String to separate the time fields."), HelperOption.new("include_seconds", "boolean", nil, "If `true`, includes a select for seconds."), HelperOption.new("ampm", "boolean", nil, "If `true`, shows hours in AM/PM format."), HelperOption.new("start_hour", "integer", nil, "The starting hour for the hour select."), HelperOption.new("end_hour", "integer", nil, "The ending hour for the hour select."), HelperOption.new("prompt", "boolean | string | hash", nil, "Set to `true` for generic prompts, a string for a custom prompt, or a hash for per-field prompts."), ], special_behaviors: [], aliases: [], ).freeze
- SELECT_YEAR =
: HelperEntry
HelperEntry.new( name: "select_year", type: HelperType::SELECT_YEAR, source: "ActionView::Helpers::DateHelper#select_year", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<select>` tag with options for each of the five years on each side of the current, which is selected. The five year radius can be changed using the `:start_year` and `:end_year` keys in the options. Both ascending and descending year lists are supported by making `:start_year` less than or greater than `:end_year`. Override the field name using the `:field_name` option, `\"year\"` by default.", signature: "select_year(date, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-select_year", implicit_attribute: nil, arguments: [ HelperArgument.new("date", 1, "date | time | integer", false, nil, false, "The date, time, or year number to pre-select."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options for customizing the year select behavior."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("field_name", "string", nil, "Override the field name, defaults to `\"year\"`."), HelperOption.new("start_year", "integer", nil, "The start year for the year select."), HelperOption.new("end_year", "integer", nil, "The end year for the year select."), HelperOption.new("prompt", "boolean | string", nil, "Set to `true` for a generic prompt or a string for a custom prompt."), ], special_behaviors: [], aliases: [], ).freeze
- TIME_AGO_IN_WORDS =
: HelperEntry
HelperEntry.new( name: "time_ago_in_words", type: HelperType::TIME_AGO_IN_WORDS, source: "ActionView::Helpers::DateHelper#time_ago_in_words", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Like `distance_of_time_in_words` but where `to_time` is fixed to `Time.now`.", signature: "time_ago_in_words(from_time, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-time_ago_in_words", implicit_attribute: nil, arguments: [ HelperArgument.new("from_time", 1, "object", false, nil, false, "Starting time."), ], options: [ HelperOption.new("include_seconds", "boolean", nil, "Include more detail for distances under 1 minute."), ], special_behaviors: [], aliases: ["distance_of_time_in_words_to_now"], ).freeze
- TIME_SELECT =
: HelperEntry
HelperEntry.new( name: "time_select", type: HelperType::TIME_SELECT, source: "ActionView::Helpers::DateHelper#time_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a set of `<select>` tags (one for hour, minute, and optionally second) pre-selected for accessing a specified time-based attribute (identified by `method`) on an object assigned to the template (identified by `object`).", signature: "time_select(object_name, method, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-time_select", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "string", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options for customizing the time select behavior."), HelperArgument.new("html_options", 4, "hash", true, "{}", false, "HTML attributes applied to every `<select>` tag in the set."), ], options: [ HelperOption.new("include_seconds", "boolean", nil, "If `true`, includes a select for seconds."), HelperOption.new("minute_step", "integer", nil, "Step value for the minute select (e.g. `15` gives 00, 15, 30, 45)."), HelperOption.new("ampm", "boolean", nil, "If `true`, shows hours in AM/PM format."), HelperOption.new("ignore_date", "boolean", nil, "If `true`, removes the hidden inputs for day, month, and year."), HelperOption.new("prompt", "boolean | string | hash", nil, "Set to `true` for generic prompts, a string for a custom prompt, or a hash for per-field prompts."), HelperOption.new("disabled", "boolean", nil, "If `true`, the select fields are disabled."), ], special_behaviors: [], aliases: [], ).freeze
- TIME_TAG =
: HelperEntry
HelperEntry.new( name: "time_tag", type: HelperType::TIME_TAG, source: "ActionView::Helpers::DateHelper#time_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "time", is_void: false, supports_block: true, preferred_for_tag: true, supported: false, detect_style: :call_name, description: "Returns an HTML `<time>` tag for the given date or time. The datetime attribute is set to the ISO 8601 representation. Content defaults to a localized long format string.", signature: "time_tag(date_or_time, *args, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-time_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("date_or_time", 1, "object", false, nil, false, "A Date, Time, or DateTime object."), HelperArgument.new("content", 2, "string", true, "nil", false, "Display text. Defaults to `I18n.l(date_or_time, format: :long)`."), ], options: [ HelperOption.new("format", "symbol", nil, "`I18n` date/time format to use. Defaults to `:long`."), HelperOption.new("datetime", "string", nil, "Override the datetime attribute value."), ], special_behaviors: [], aliases: [], ).freeze
- DEBUG =
: HelperEntry
HelperEntry.new( name: "debug", type: HelperType::DEBUG, source: "ActionView::Helpers::DebugHelper#debug", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a YAML representation of the object wrapped in a `<pre>` tag for display.", signature: "debug(object)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/DebugHelper.html#method-i-debug", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "object", false, nil, false, "Object to debug."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- APPLY_FORM_FOR_OPTIONS_BANG =
: HelperEntry
HelperEntry.new( name: "apply_form_for_options!", type: HelperType::APPLY_FORM_FOR_OPTIONS_BANG, source: "ActionView::Helpers::FormHelper#apply_form_for_options!", gem: "actionview", output: :void, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Applies default form options based on the model object. Determines the URL, method, and scope automatically.", signature: "apply_form_for_options!(object, options)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- BUTTON =
: HelperEntry
HelperEntry.new( name: "button", type: HelperType::BUTTON, source: "ActionView::Helpers::FormHelper#button", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a `<button type=\"submit\">` for the form. When no value is given, it generates a label based on whether the object is a new or persisted record. Accepts a block for custom button content. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "button(value = nil, options = {}, &block)", documentation_url: "", implicit_attribute: nil, arguments: [ HelperArgument.new("value", 1, "string | symbol", true, "nil", false, "Button text or a Symbol mapped to `field_name`/`field_id`. Auto-generated from the model if omitted."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("disabled", "boolean", nil, "If `true`, the button is disabled."), HelperOption.new("formmethod", "string", nil, "HTTP method for the button's form submission."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- CHECKBOX =
: HelperEntry
HelperEntry.new( name: "checkbox", type: HelperType::CHECKBOX, source: "ActionView::Helpers::FormHelper#checkbox", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"checkbox\">` for a specified attribute on a model object, along with a hidden field for the unchecked value. Also available as `check_box`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "checkbox(object_name, method, options = {}, checked_value = \"1\", unchecked_value = \"0\")", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-checkbox", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), HelperArgument.new("checked_value", 4, "string", true, "\"1\"", false, "Value submitted when the checkbox is checked."), HelperArgument.new("unchecked_value", 5, "string", true, "\"0\"", false, "Value submitted when the checkbox is unchecked (via hidden field)."), ], options: [ HelperOption.new("include_hidden", "boolean", nil, "If `false`, omits the hidden field for the unchecked value."), ], special_behaviors: [], aliases: ["check_box"], ).freeze
- COLOR_FIELD =
: HelperEntry
HelperEntry.new( name: "color_field", type: HelperType::COLOR_FIELD, source: "ActionView::Helpers::FormHelper#color_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"color\">` for a specified attribute on a model object. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "color_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-color_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- DATE_FIELD =
: HelperEntry
HelperEntry.new( name: "date_field", type: HelperType::DATE_FIELD, source: "ActionView::Helpers::FormHelper#date_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"date\">` for a specified attribute on a model object. The default value is formatted with `strftime(\"%Y-%m-%d\")`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "date_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-date_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("min", "string | date", nil, "Minimum date value (ISO8601 string or Date/Time object)."), HelperOption.new("max", "string | date", nil, "Maximum date value (ISO8601 string or Date/Time object)."), ], special_behaviors: [], aliases: [], ).freeze
- DATETIME_FIELD =
: HelperEntry
HelperEntry.new( name: "datetime_field", type: HelperType::DATETIME_FIELD, source: "ActionView::Helpers::FormHelper#datetime_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"datetime-local\">` for a specified attribute on a model object. The default value is formatted with `strftime(\"%Y-%m-%dT%T\")`. Also available as `datetime_local_field`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "datetime_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-datetime_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("include_seconds", "boolean", nil, "If `false`, renders just date, hour, and minute without seconds."), HelperOption.new("min", "string | date | time", nil, "Minimum datetime value (ISO8601 string or Date/Time object)."), HelperOption.new("max", "string | date | time", nil, "Maximum datetime value (ISO8601 string or Date/Time object)."), ], special_behaviors: [], aliases: ["datetime_local_field"], ).freeze
- EMAIL_FIELD =
: HelperEntry
HelperEntry.new( name: "email_field", type: HelperType::EMAIL_FIELD, source: "ActionView::Helpers::FormHelper#email_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"email\">` for a specified attribute on a model object. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "email_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-email_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- EMITTED_HIDDEN_ID_P =
: HelperEntry
HelperEntry.new( name: "emitted_hidden_id?", type: HelperType::EMITTED_HIDDEN_ID_P, source: "ActionView::Helpers::FormHelper#emitted_hidden_id?", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether the hidden `id` field has already been emitted for this form builder.", signature: "emitted_hidden_id?", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FIELDS =
: HelperEntry
HelperEntry.new( name: "fields", type: HelperType::FIELDS, source: "ActionView::Helpers::FormHelper#fields", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Scopes input fields to a model object. This is the model-bound version used inside `form_with`/`form_for` blocks to create a nested scope for form fields.", signature: "fields(scope = nil, model: nil, **options, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-fields", implicit_attribute: nil, arguments: [ HelperArgument.new("scope", 1, "string | symbol", true, "nil", false, "The scope for the fields (used as the parameter key prefix)."), ], options: [ HelperOption.new("model", "object", nil, "The model object to scope fields to."), HelperOption.new("index", "string | integer", nil, "Index for nested attributes."), HelperOption.new("builder", "class", nil, "Custom form builder class."), ], special_behaviors: [], aliases: [], ).freeze
- FIELDS_FOR =
: HelperEntry
HelperEntry.new( name: "fields_for", type: HelperType::FIELDS_FOR, source: "ActionView::Helpers::FormHelper#fields_for", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a scope around a specific model object, like `form_with`, but without building a `<form>` tag. Useful for specifying additional model objects in the same form.", signature: "fields_for(record_name, record_object = nil, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-fields_for", implicit_attribute: nil, arguments: [ HelperArgument.new("record_name", 1, "string | symbol", false, nil, false, "Name of the model object."), HelperArgument.new("record_object", 2, "object", true, "nil", false, "The model object to scope fields to."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FILE_FIELD =
: HelperEntry
HelperEntry.new( name: "file_field", type: HelperType::FILE_FIELD, source: "ActionView::Helpers::FormHelper#file_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"file\">` for a specified attribute on a model object. Sets the enclosing form's encoding to `multipart/form-data`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "file_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-file_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("multiple", "boolean", nil, "If `true`, allows selecting multiple files."), HelperOption.new("include_hidden", "boolean", nil, "When `multiple: true`, prefixes with a hidden field for empty submissions."), HelperOption.new("accept", "string", nil, "Mime type(s) to filter the file chooser."), HelperOption.new("direct_upload", "boolean", nil, "If `true`, enables Active Storage direct upload."), ], special_behaviors: [], aliases: [], ).freeze
- FORM_FOR =
: HelperEntry
HelperEntry.new( name: "form_for", type: HelperType::FORM_FOR, source: "ActionView::Helpers::FormHelper#form_for", gem: "actionview", output: :html, visibility: "public", tag_name: "form", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a form that allows the user to create or update the attributes of a specific model object. Superseded by `form_with` in modern Rails.", signature: "form_for(record, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-form_for", implicit_attribute: nil, arguments: [ HelperArgument.new("record", 1, "object", false, nil, false, "The model object the form is for."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Form options hash."), ], options: [ HelperOption.new("url", "string | hash", nil, "URL the form submits to."), HelperOption.new("method", "symbol", nil, "HTTP method for the form."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- FORM_WITH =
: HelperEntry
HelperEntry.new( name: "form_with", type: HelperType::FORM_WITH, source: "ActionView::Helpers::FormHelper#form_with", gem: "actionview", output: :html, visibility: "public", tag_name: "form", is_void: false, supports_block: true, preferred_for_tag: true, supported: false, detect_style: :call_name, description: "Creates a `<form>` tag based on mixing URLs, scopes, or models. Using just a URL, adding a scope, or passing a model object are all supported. An existing model makes an update form and fills out field values. The preferred way to create forms in modern Rails.", signature: "form_with(model: nil, scope: nil, url: nil, format: nil, **options, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-form_with", implicit_attribute: nil, arguments: [ ], options: [ HelperOption.new("model", "object", nil, "A model object to infer URL and scope from."), HelperOption.new("scope", "string | symbol", nil, "Scope to prefix input field names with."), HelperOption.new("url", "string | hash", nil, "URL the form submits to."), HelperOption.new("method", "symbol", nil, "HTTP method for the form (`:get`, `:post`, `:patch`, `:delete`)."), HelperOption.new("local", "boolean", nil, "If `true`, disables remote form submission."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), HelperOption.new("class", "string", nil, "CSS class name(s)."), ], special_behaviors: [], aliases: [], ).freeze
- FORM_WITH_GENERATES_IDS =
: HelperEntry
HelperEntry.new( name: "form_with_generates_ids", type: HelperType::FORM_WITH_GENERATES_IDS, source: "ActionView::Helpers::FormHelper#form_with_generates_ids", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether `form_with` generates `id` attributes on form elements by default.", signature: "form_with_generates_ids", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FORM_WITH_GENERATES_REMOTE_FORMS =
: HelperEntry
HelperEntry.new( name: "form_with_generates_remote_forms", type: HelperType::FORM_WITH_GENERATES_REMOTE_FORMS, source: "ActionView::Helpers::FormHelper#form_with_generates_remote_forms", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether `form_with` generates `data-remote` forms by default.", signature: "form_with_generates_remote_forms", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- HIDDEN_FIELD =
: HelperEntry
HelperEntry.new( name: "hidden_field", type: HelperType::HIDDEN_FIELD, source: "ActionView::Helpers::FormHelper#hidden_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"hidden\">` for a specified attribute on a model object. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "hidden_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-hidden_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- LABEL =
: HelperEntry
HelperEntry.new( name: "label", type: HelperType::LABEL, source: "ActionView::Helpers::FormHelper#label", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a `<label>` tag for a specified attribute on a model object. The label text defaults to the attribute name unless a translation is found or explicitly provided. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "label(object_name, method, content_or_options = nil, options = nil, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-label", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("content_or_options", 3, "string | hash", true, "nil", false, "Label text string, or options hash when a block is given."), HelperArgument.new("options", 4, "hash", true, "nil", false, "HTML attributes hash."), ], options: [ HelperOption.new("value", "string", nil, "Value used in the `for` attribute to target a specific radio button."), HelperOption.new("class", "string", nil, "CSS class name(s)."), HelperOption.new("for", "string", nil, "Explicit `for` attribute value."), ], special_behaviors: [], aliases: [], ).freeze
- MONTH_FIELD =
: HelperEntry
HelperEntry.new( name: "month_field", type: HelperType::MONTH_FIELD, source: "ActionView::Helpers::FormHelper#month_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"month\">` for a specified attribute on a model object. The default value is formatted with `strftime(\"%Y-%m\")`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "month_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-month_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- MULTIPART =
: HelperEntry
HelperEntry.new( name: "multipart", type: HelperType::MULTIPART, source: "ActionView::Helpers::FormHelper#multipart", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether the form builder has been set to use `multipart/form-data` encoding.", signature: "multipart", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- MULTIPLE_FILE_FIELD_INCLUDE_HIDDEN =
: HelperEntry
HelperEntry.new( name: "multiple_file_field_include_hidden", type: HelperType::MULTIPLE_FILE_FIELD_INCLUDE_HIDDEN, source: "ActionView::Helpers::FormHelper#multiple_file_field_include_hidden", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether multiple file fields include a hidden field to allow clearing.", signature: "multiple_file_field_include_hidden", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- NUMBER_FIELD =
: HelperEntry
HelperEntry.new( name: "number_field", type: HelperType::NUMBER_FIELD, source: "ActionView::Helpers::FormHelper#number_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"number\">` for a specified attribute on a model object. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "number_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-number_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("min", "string | number", nil, "Minimum allowed value."), HelperOption.new("max", "string | number", nil, "Maximum allowed value."), HelperOption.new("step", "string | number", nil, "Step increment."), HelperOption.new("in", "range", nil, "Range that sets `min`, `max`, and `step`."), ], special_behaviors: [], aliases: [], ).freeze
- PASSWORD_FIELD =
: HelperEntry
HelperEntry.new( name: "password_field", type: HelperType::PASSWORD_FIELD, source: "ActionView::Helpers::FormHelper#password_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"password\">` for a specified attribute on a model object. The field is blank by default for security reasons. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "password_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-password_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- RADIO_BUTTON =
: HelperEntry
HelperEntry.new( name: "radio_button", type: HelperType::RADIO_BUTTON, source: "ActionView::Helpers::FormHelper#radio_button", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"radio\">` for a specified attribute on a model object. The radio button is checked if the current value of the method matches `tag_value`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "radio_button(object_name, method, tag_value, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-radio_button", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("tag_value", 3, "string", false, nil, false, "The value of this radio button option."), HelperArgument.new("options", 4, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- RANGE_FIELD =
: HelperEntry
HelperEntry.new( name: "range_field", type: HelperType::RANGE_FIELD, source: "ActionView::Helpers::FormHelper#range_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"range\">` for a specified attribute on a model object. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "range_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-range_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("min", "string | number", nil, "Minimum allowed value."), HelperOption.new("max", "string | number", nil, "Maximum allowed value."), HelperOption.new("step", "string | number", nil, "Step increment."), HelperOption.new("in", "range", nil, "Range that sets `min`, `max`, and `step`."), ], special_behaviors: [], aliases: [], ).freeze
- SEARCH_FIELD =
: HelperEntry
HelperEntry.new( name: "search_field", type: HelperType::SEARCH_FIELD, source: "ActionView::Helpers::FormHelper#search_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"search\">` for a specified attribute on a model object. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "search_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-search_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SUBMIT =
: HelperEntry
HelperEntry.new( name: "submit", type: HelperType::SUBMIT, source: "ActionView::Helpers::FormHelper#submit", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a submit button for the form. When no value is given, it generates a label based on whether the object is a new or persisted record (e.g. \"Create Article\" or \"Update Article\"). This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "submit(value = nil, options = {})", documentation_url: "", implicit_attribute: nil, arguments: [ HelperArgument.new("value", 1, "string", true, "nil", false, "Caption text for the submit button. Auto-generated from the model if omitted."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("disabled", "boolean", nil, "If `true`, the button is disabled."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- TELEPHONE_FIELD =
: HelperEntry
HelperEntry.new( name: "telephone_field", type: HelperType::TELEPHONE_FIELD, source: "ActionView::Helpers::FormHelper#telephone_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"tel\">` for a specified attribute on a model object. Also available as `phone_field`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "telephone_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-telephone_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: ["phone_field"], ).freeze
- TEXT_FIELD =
: HelperEntry
HelperEntry.new( name: "text_field", type: HelperType::TEXT_FIELD, source: "ActionView::Helpers::FormHelper#text_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"text\">` for a specified attribute on a model object. Generates `name=\"object_name[method]\"` and populates the value from the object. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "text_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-text_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TEXTAREA =
: HelperEntry
HelperEntry.new( name: "textarea", type: HelperType::TEXTAREA, source: "ActionView::Helpers::FormHelper#textarea", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a `<textarea>` for a specified attribute on a model object. Also available as `text_area`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "textarea(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-textarea", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("size", "string", nil, "Columns and rows in `\"COLSxROWS\"` format (e.g. `\"20x30\"`)."), ], special_behaviors: [], aliases: ["text_area"], ).freeze
- TIME_FIELD =
: HelperEntry
HelperEntry.new( name: "time_field", type: HelperType::TIME_FIELD, source: "ActionView::Helpers::FormHelper#time_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"time\">` for a specified attribute on a model object. The default value is formatted with `strftime(\"%T.%L\")`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "time_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-time_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("include_seconds", "boolean", nil, "If `false`, formats value as `\"%H:%M\"` without seconds."), HelperOption.new("min", "string | time", nil, "Minimum time value (ISO8601 string or Time object)."), HelperOption.new("max", "string | time", nil, "Maximum time value (ISO8601 string or Time object)."), ], special_behaviors: [], aliases: [], ).freeze
- URL_FIELD =
: HelperEntry
HelperEntry.new( name: "url_field", type: HelperType::URL_FIELD, source: "ActionView::Helpers::FormHelper#url_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"url\">` for a specified attribute on a model object. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "url_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-url_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- WEEK_FIELD =
: HelperEntry
HelperEntry.new( name: "week_field", type: HelperType::WEEK_FIELD, source: "ActionView::Helpers::FormHelper#week_field", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an `<input type=\"week\">` for a specified attribute on a model object. The default value is formatted with `strftime(\"%Y-W%W\")`. This is the model-bound version used inside `form_with`/`form_for` blocks.", signature: "week_field(object_name, method, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-week_field", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string | symbol", false, nil, false, "The name of the object."), HelperArgument.new("method", 2, "symbol", false, nil, false, "The attribute name on the object."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- COLLECTION_CHECKBOXES =
: HelperEntry
HelperEntry.new( name: "collection_checkboxes", type: HelperType::COLLECTION_CHECKBOXES, source: "ActionView::Helpers::FormOptionsHelper#collection_checkboxes", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns check box tags for the collection of existing return values of `method` for `object`'s class. The value returned from calling `method` on the instance `object` will be selected. If calling `method` returns `nil`, no selection is made.", signature: "collection_checkboxes(object, method, collection, value_method, text_method, options = {}, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_checkboxes", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "string | symbol", false, nil, false, "The object name."), HelperArgument.new("method", 2, "string | symbol", false, nil, false, "The attribute of the object."), HelperArgument.new("collection", 3, "array", false, nil, false, "The collection of objects to build checkboxes from."), HelperArgument.new("value_method", 4, "symbol | string", false, nil, false, "Method to call on each member of `collection` to get the checkbox value."), HelperArgument.new("text_method", 5, "symbol | string", false, nil, false, "Method to call on each member of `collection` to get the label text."), HelperArgument.new("options", 6, "hash", true, "{}", false, "Options hash."), HelperArgument.new("html_options", 7, "hash", true, "{}", false, "HTML attributes for each checkbox tag."), ], options: [ HelperOption.new("include_hidden", "boolean", nil, "If `false`, prevents the hidden field from being generated."), ], special_behaviors: [], aliases: ["collection_check_boxes"], ).freeze
- COLLECTION_RADIO_BUTTONS =
: HelperEntry
HelperEntry.new( name: "collection_radio_buttons", type: HelperType::COLLECTION_RADIO_BUTTONS, source: "ActionView::Helpers::FormOptionsHelper#collection_radio_buttons", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns radio button tags for the collection of existing return values of `method` for `object`'s class. The value returned from calling `method` on the instance `object` will be selected. If calling `method` returns `nil`, no selection is made.", signature: "collection_radio_buttons(object, method, collection, value_method, text_method, options = {}, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_radio_buttons", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "string | symbol", false, nil, false, "The object name."), HelperArgument.new("method", 2, "string | symbol", false, nil, false, "The attribute of the object."), HelperArgument.new("collection", 3, "array", false, nil, false, "The collection of objects to build radio buttons from."), HelperArgument.new("value_method", 4, "symbol | string", false, nil, false, "Method to call on each member of `collection` to get the radio button value."), HelperArgument.new("text_method", 5, "symbol | string", false, nil, false, "Method to call on each member of `collection` to get the label text."), HelperArgument.new("options", 6, "hash", true, "{}", false, "Options hash."), HelperArgument.new("html_options", 7, "hash", true, "{}", false, "HTML attributes for each radio button tag."), ], options: [ HelperOption.new("include_hidden", "boolean", nil, "If `false`, prevents the hidden field from being generated."), ], special_behaviors: [], aliases: [], ).freeze
- COLLECTION_SELECT =
: HelperEntry
HelperEntry.new( name: "collection_select", type: HelperType::COLLECTION_SELECT, source: "ActionView::Helpers::FormOptionsHelper#collection_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns `<select>` and `<option>` tags for the collection of existing return values of `method` for `object`'s class. The value returned from calling `method` on the instance `object` will be selected. If calling `method` returns `nil`, no selection is made without including `:prompt` or `:include_blank` in the options hash.", signature: "collection_select(object, method, collection, value_method, text_method, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_select", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "string | symbol", false, nil, false, "The object name for the select tag."), HelperArgument.new("method", 2, "string | symbol", false, nil, false, "The attribute of the object corresponding to the select tag."), HelperArgument.new("collection", 3, "array", false, nil, false, "The collection of objects to build options from."), HelperArgument.new("value_method", 4, "symbol | string", false, nil, false, "Method to call on each member of `collection` to get the option value."), HelperArgument.new("text_method", 5, "symbol | string", false, nil, false, "Method to call on each member of `collection` to get the option text."), HelperArgument.new("options", 6, "hash", true, "{}", false, "Options hash for customizing the select behavior."), HelperArgument.new("html_options", 7, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("include_blank", "boolean | string", nil, "Include a blank option at the top of the select."), HelperOption.new("prompt", "boolean | string", nil, "Prepend an option with a generic prompt or the given prompt string."), HelperOption.new("selected", "string | array", nil, "Value to use for the selected option."), HelperOption.new("disabled", "string | array | proc", nil, "Value, values, or Proc to determine disabled options."), ], special_behaviors: [], aliases: [], ).freeze
- GROUPED_COLLECTION_SELECT =
: HelperEntry
HelperEntry.new( name: "grouped_collection_select", type: HelperType::GROUPED_COLLECTION_SELECT, source: "ActionView::Helpers::FormOptionsHelper#grouped_collection_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns `<select>`, `<optgroup>`, and `<option>` tags for the collection of existing return values of `method` for `object`'s class. The value returned from calling `method` on the instance `object` will be selected. If calling `method` returns `nil`, no selection is made without including `:prompt` or `:include_blank` in the options hash.", signature: "grouped_collection_select(object, method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-grouped_collection_select", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "string | symbol", false, nil, false, "The object name for the select tag."), HelperArgument.new("method", 2, "string | symbol", false, nil, false, "The attribute of the object corresponding to the select tag."), HelperArgument.new("collection", 3, "array", false, nil, false, "An array of objects representing the `<optgroup>` tags."), HelperArgument.new("group_method", 4, "symbol | string", false, nil, false, "Method to call on a member of `collection` to return an array of child objects for the `<option>` tags."), HelperArgument.new("group_label_method", 5, "symbol | string", false, nil, false, "Method to call on a member of `collection` to return the `label` attribute for its `<optgroup>` tag."), HelperArgument.new("option_key_method", 6, "symbol | string", false, nil, false, "Method to call on a child object to return the `value` attribute for its `<option>` tag."), HelperArgument.new("option_value_method", 7, "symbol | string", false, nil, false, "Method to call on a child object to return the contents of its `<option>` tag."), HelperArgument.new("options", 8, "hash", true, "{}", false, "Options hash for customizing the select behavior."), HelperArgument.new("html_options", 9, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("include_blank", "boolean | string", nil, "Include a blank option at the top of the select."), HelperOption.new("prompt", "boolean | string", nil, "Prepend an option with a generic prompt or the given prompt string."), ], special_behaviors: [], aliases: [], ).freeze
- GROUPED_OPTIONS_FOR_SELECT =
: HelperEntry
HelperEntry.new( name: "grouped_options_for_select", type: HelperType::GROUPED_OPTIONS_FOR_SELECT, source: "ActionView::Helpers::FormOptionsHelper#grouped_options_for_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a string of `<option>` tags, like `options_for_select`, but wraps them with `<optgroup>` tags. Accepts a nested array or hash of strings where the first value serves as the `<optgroup>` label and the second value must be an array of options.", signature: "grouped_options_for_select(grouped_options, selected_key = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-grouped_options_for_select", implicit_attribute: nil, arguments: [ HelperArgument.new("grouped_options", 1, "array | hash", false, nil, false, "A nested array or hash of strings for grouped option tags."), HelperArgument.new("selected_key", 2, "string | array", true, "nil", false, "The value(s) to be selected."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options hash."), ], options: [ HelperOption.new("prompt", "boolean | string", nil, "Prepend an option with a generic prompt or the given prompt string."), HelperOption.new("divider", "string", nil, "The divider string for option groups."), ], special_behaviors: [], aliases: [], ).freeze
- OPTION_GROUPS_FROM_COLLECTION_FOR_SELECT =
: HelperEntry
HelperEntry.new( name: "option_groups_from_collection_for_select", type: HelperType::OPTION_GROUPS_FROM_COLLECTION_FOR_SELECT, source: "ActionView::Helpers::FormOptionsHelper#option_groups_from_collection_for_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a string of `<option>` tags, like `options_from_collection_for_select`, but groups them by `<optgroup>` tags based on the object relationships of the arguments.", signature: "option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, selected_key = nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-option_groups_from_collection_for_select", implicit_attribute: nil, arguments: [ HelperArgument.new("collection", 1, "array", false, nil, false, "An array of objects representing the `<optgroup>` tags."), HelperArgument.new("group_method", 2, "symbol | string", false, nil, false, "Method to call on a member of `collection` to return an array of child objects for the `<option>` tags."), HelperArgument.new("group_label_method", 3, "symbol | string", false, nil, false, "Method to call on a member of `collection` to return the `label` attribute for its `<optgroup>` tag."), HelperArgument.new("option_key_method", 4, "symbol | string", false, nil, false, "Method to call on a child object to return the `value` attribute for its `<option>` tag."), HelperArgument.new("option_value_method", 5, "symbol | string", false, nil, false, "Method to call on a child object to return the contents of its `<option>` tag."), HelperArgument.new("selected_key", 6, "string | hash", true, "nil", false, "The selected value, or a hash with `:selected` and `:disabled` keys."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- OPTIONS_FOR_SELECT =
: HelperEntry
HelperEntry.new( name: "options_for_select", type: HelperType::OPTIONS_FOR_SELECT, source: "ActionView::Helpers::FormOptionsHelper#options_for_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Accepts a container (hash, array, enumerable, your type) and returns a string of `<option>` tags. Given a container where the elements respond to `first` and `last` (such as a two-element array), the \"lasts\" serve as option values and the \"firsts\" as option text. Hashes are turned into this form automatically, so the keys become \"firsts\" and values become lasts.", signature: "options_for_select(container, selected = nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-options_for_select", implicit_attribute: nil, arguments: [ HelperArgument.new("container", 1, "array | hash", false, nil, false, "The collection of options. Arrays, hashes, and enumerables are accepted."), HelperArgument.new("selected", 2, "string | array | hash", true, "nil", false, "The value(s) to be selected, or a hash with `:selected` and `:disabled` keys."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- OPTIONS_FROM_COLLECTION_FOR_SELECT =
: HelperEntry
HelperEntry.new( name: "options_from_collection_for_select", type: HelperType::OPTIONS_FROM_COLLECTION_FOR_SELECT, source: "ActionView::Helpers::FormOptionsHelper#options_from_collection_for_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a string of `<option>` tags that have been compiled by iterating over the `collection` and assigning the result of a call to the `value_method` as the option value and the `text_method` as the option text.", signature: "options_from_collection_for_select(collection, value_method, text_method, selected = nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-options_from_collection_for_select", implicit_attribute: nil, arguments: [ HelperArgument.new("collection", 1, "array", false, nil, false, "The collection of objects to build options from."), HelperArgument.new("value_method", 2, "symbol | string", false, nil, false, "Method to call on each member to get the option value."), HelperArgument.new("text_method", 3, "symbol | string", false, nil, false, "Method to call on each member to get the option text."), HelperArgument.new("selected", 4, "string | array | hash | proc", true, "nil", false, "The selected value(s), a Proc, or a hash with `:selected` and `:disabled` keys."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SELECT =
: HelperEntry
HelperEntry.new( name: "select", type: HelperType::SELECT, source: "ActionView::Helpers::FormOptionsHelper#select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a `<select>` tag and a series of contained `<option>` tags for the provided object and method. The option currently held by the object will be selected, provided that the object is available.", signature: "select(object, method, choices = nil, options = {}, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "string | symbol", false, nil, false, "The object name for the select tag."), HelperArgument.new("method", 2, "string | symbol", false, nil, false, "The attribute of the object corresponding to the select tag."), HelperArgument.new("choices", 3, "array | hash", true, "nil", false, "A flat collection or nested collection for the option tags."), HelperArgument.new("options", 4, "hash", true, "{}", false, "Options hash for customizing the select behavior."), HelperArgument.new("html_options", 5, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("include_blank", "boolean | string", nil, "Include a blank option at the top of the select."), HelperOption.new("prompt", "boolean | string", nil, "Prepend an option with a generic prompt or the given prompt string."), HelperOption.new("selected", "string | array", nil, "Value to use for the selected option."), HelperOption.new("disabled", "string | array", nil, "Value or values to be disabled in the option tags."), HelperOption.new("include_hidden", "boolean", nil, "If `false`, prevents the hidden field from being generated for multiple selects."), ], special_behaviors: [], aliases: [], ).freeze
- TIME_ZONE_OPTIONS_FOR_SELECT =
: HelperEntry
HelperEntry.new( name: "time_zone_options_for_select", type: HelperType::TIME_ZONE_OPTIONS_FOR_SELECT, source: "ActionView::Helpers::FormOptionsHelper#time_zone_options_for_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a string of `<option>` tags for pretty much any time zone in the world. Supply an `ActiveSupport::TimeZone` name as `selected` to have it marked as the selected option tag. You can also supply an array of `ActiveSupport::TimeZone` objects as `priority_zones` so that they will be listed above the rest of the list.", signature: "time_zone_options_for_select(selected = nil, priority_zones = nil, model = ::ActiveSupport::TimeZone)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-time_zone_options_for_select", implicit_attribute: nil, arguments: [ HelperArgument.new("selected", 1, "string", true, "nil", false, "The time zone name to be selected."), HelperArgument.new("priority_zones", 2, "array | regexp", true, "nil", false, "An array of `ActiveSupport::TimeZone` objects or a Regexp to list above the rest."), HelperArgument.new("model", 3, "class", true, "::ActiveSupport::TimeZone", false, "The time zone model object. Must respond to `all` and return objects that respond to `name`."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TIME_ZONE_SELECT =
: HelperEntry
HelperEntry.new( name: "time_zone_select", type: HelperType::TIME_ZONE_SELECT, source: "ActionView::Helpers::FormOptionsHelper#time_zone_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns `<select>` and `<option>` tags for the given object and method, using `time_zone_options_for_select` to generate the list of option tags.", signature: "time_zone_select(object, method, priority_zones = nil, options = {}, html_options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-time_zone_select", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "string | symbol", false, nil, false, "The object name for the select tag."), HelperArgument.new("method", 2, "string | symbol", false, nil, false, "The attribute of the object corresponding to the select tag."), HelperArgument.new("priority_zones", 3, "array | regexp", true, "nil", false, "An array of `ActiveSupport::TimeZone` objects or a Regexp to list above the rest."), HelperArgument.new("options", 4, "hash", true, "{}", false, "Options hash for customizing the select behavior."), HelperArgument.new("html_options", 5, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ HelperOption.new("include_blank", "boolean | string", nil, "Include a blank option at the top of the select."), HelperOption.new("model", "class", nil, "Time zone model object, defaults to `ActiveSupport::TimeZone`."), HelperOption.new("default", "string", nil, "Default `ActiveSupport::TimeZone` name if the object's time zone is `nil`."), ], special_behaviors: [], aliases: [], ).freeze
- WEEKDAY_OPTIONS_FOR_SELECT =
: HelperEntry
HelperEntry.new( name: "weekday_options_for_select", type: HelperType::WEEKDAY_OPTIONS_FOR_SELECT, source: "ActionView::Helpers::FormOptionsHelper#weekday_options_for_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a string of `<option>` tags for the days of the week.", signature: "weekday_options_for_select(selected = nil, index_as_value: false, day_format: :day_names, beginning_of_week: Date.beginning_of_week)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-weekday_options_for_select", implicit_attribute: nil, arguments: [ HelperArgument.new("selected", 1, "string", true, "nil", false, "The weekday to be selected."), ], options: [ HelperOption.new("index_as_value", "boolean", nil, "If `true`, uses the indexes from `I18n.translate(\"date.day_names\")` as the values."), HelperOption.new("day_format", "symbol", nil, "The I18n key of the array to use for the weekday options. Defaults to `:day_names`."), HelperOption.new("beginning_of_week", "symbol", nil, "Defaults to `Date.beginning_of_week`."), ], special_behaviors: [], aliases: [], ).freeze
- WEEKDAY_SELECT =
: HelperEntry
HelperEntry.new( name: "weekday_select", type: HelperType::WEEKDAY_SELECT, source: "ActionView::Helpers::FormOptionsHelper#weekday_select", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns `<select>` and `<option>` tags for the given object and method, using `weekday_options_for_select` to generate the list of option tags.", signature: "weekday_select(object, method, options = {}, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-weekday_select", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "string | symbol", false, nil, false, "The object name for the select tag."), HelperArgument.new("method", 2, "string | symbol", false, nil, false, "The attribute of the object corresponding to the select tag."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options hash for customizing the select behavior."), HelperArgument.new("html_options", 4, "hash", true, "{}", false, "HTML attributes for the `<select>` tag."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- BUTTON_TAG =
: HelperEntry
HelperEntry.new( name: "button_tag", type: HelperType::BUTTON_TAG, source: "ActionView::Helpers::FormTagHelper#button_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "button", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a button element that defines a submit button, reset button, or a generic button which can be used in JavaScript.", signature: "button_tag(content_or_options = nil, options = nil, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-button_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("content_or_options", 1, "string | hash", true, "nil", false, "Button text, or options hash when block is given."), HelperArgument.new("options", 2, "hash", true, "nil", false, "HTML attributes hash."), ], options: [ HelperOption.new("disabled", "boolean", nil, "If `true`, the button is disabled."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- CHECKBOX_TAG =
: HelperEntry
HelperEntry.new( name: "checkbox_tag", type: HelperType::CHECKBOX_TAG, source: "ActionView::Helpers::FormTagHelper#checkbox_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a check box form input tag.", signature: "checkbox_tag(name, value = \"1\", checked = false, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-checkbox_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the checkbox."), HelperArgument.new("value", 2, "string", true, "1", false, "Value submitted when checked."), HelperArgument.new("checked", 3, "boolean", true, "false", false, "Whether the checkbox is checked by default."), HelperArgument.new("options", 4, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: ["check_box_tag"], ).freeze
- COLOR_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "color_field_tag", type: HelperType::COLOR_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#color_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"color\"`.", signature: "color_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-color_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default color value (e.g. `\"#000000\"`)."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- DATE_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "date_field_tag", type: HelperType::DATE_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#date_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"date\"`.", signature: "date_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-date_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default date value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- DATETIME_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "datetime_field_tag", type: HelperType::DATETIME_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#datetime_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"datetime-local\"`.", signature: "datetime_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-datetime_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default datetime value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: ["datetime_local_field_tag"], ).freeze
- DEFAULT_ENFORCE_UTF8 =
: HelperEntry
HelperEntry.new( name: "default_enforce_utf8", type: HelperType::DEFAULT_ENFORCE_UTF8, source: "ActionView::Helpers::FormTagHelper#default_enforce_utf8", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether forms include the hidden UTF-8 enforcer input field.", signature: "default_enforce_utf8", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- EMAIL_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "email_field_tag", type: HelperType::EMAIL_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#email_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"email\"`.", signature: "email_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-email_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default email value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- EMBED_AUTHENTICITY_TOKEN_IN_REMOTE_FORMS =
: HelperEntry
HelperEntry.new( name: "embed_authenticity_token_in_remote_forms", type: HelperType::EMBED_AUTHENTICITY_TOKEN_IN_REMOTE_FORMS, source: "ActionView::Helpers::FormTagHelper#embed_authenticity_token_in_remote_forms", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether remote forms embed the CSRF authenticity token as a hidden field.", signature: "embed_authenticity_token_in_remote_forms", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- FIELD_ID =
: HelperEntry
HelperEntry.new( name: "field_id", type: HelperType::FIELD_ID, source: "ActionView::Helpers::FormTagHelper#field_id", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Generates a DOM id for a form field based on the object name and method, with optional suffixes. Used to create matching `for` attributes on labels.", signature: "field_id(object_name, method_name, *suffixes, index: nil, namespace: nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-field_id", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string", false, nil, false, "The name of the object."), HelperArgument.new("method_name", 2, "string", false, nil, false, "The name of the attribute."), ], options: [ HelperOption.new("index", "integer", nil, "Index for nested fields."), HelperOption.new("namespace", "string", nil, "Namespace prefix for the id."), ], special_behaviors: [], aliases: [], ).freeze
- FIELD_NAME =
: HelperEntry
HelperEntry.new( name: "field_name", type: HelperType::FIELD_NAME, source: "ActionView::Helpers::FormTagHelper#field_name", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Generates an HTML `name` attribute value for a form field based on the object name and method.", signature: "field_name(object_name, method_name, *method_names, multiple: false, index: nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-field_name", implicit_attribute: nil, arguments: [ HelperArgument.new("object_name", 1, "string", false, nil, false, "The name of the object."), HelperArgument.new("method_name", 2, "string", false, nil, false, "The name of the attribute."), ], options: [ HelperOption.new("multiple", "boolean", nil, "If `true`, appends `[]` to the name for array parameters."), HelperOption.new("index", "integer", nil, "Index for nested fields."), ], special_behaviors: [], aliases: [], ).freeze
- FIELD_SET_TAG =
: HelperEntry
HelperEntry.new( name: "field_set_tag", type: HelperType::FIELD_SET_TAG, source: "ActionView::Helpers::FormTagHelper#field_set_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "fieldset", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a field set for grouping HTML form elements.", signature: "field_set_tag(legend = nil, options = nil, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-field_set_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("legend", 1, "string", true, "nil", false, "Legend text displayed at the top of the fieldset."), HelperArgument.new("options", 2, "hash", true, "nil", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: ["fieldset_tag"], ).freeze
- FILE_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "file_field_tag", type: HelperType::FILE_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#file_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a file upload field. If you are using file uploads then you will also need to set the `multipart` option for the form tag.", signature: "file_field_tag(name, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-file_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the file input."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("disabled", "boolean", nil, "If `true`, the input is disabled."), HelperOption.new("multiple", "boolean", nil, "If `true`, allows multiple file selection."), HelperOption.new("accept", "string", nil, "File types to accept (e.g. `\"image/*\"`)."), ], special_behaviors: [], aliases: [], ).freeze
- FORM_TAG =
: HelperEntry
HelperEntry.new( name: "form_tag", type: HelperType::FORM_TAG, source: "ActionView::Helpers::FormTagHelper#form_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "form", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Starts a form tag that points the action to a URL configured with `url_for_options`. The method for the form defaults to POST. Superseded by `form_with` in modern Rails.", signature: "form_tag(url_for_options = {}, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-form_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("url_for_options", 1, "string | hash", true, "{}", false, "URL or `url_for` options."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("method", "symbol", nil, "HTTP method for the form."), HelperOption.new("multipart", "boolean", nil, "If `true`, sets enctype to `multipart/form-data`."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- HIDDEN_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "hidden_field_tag", type: HelperType::HIDDEN_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#hidden_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a hidden form input field used to transmit data that would be lost due to HTTP's statelessness or data that should be hidden from the user.", signature: "hidden_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-hidden_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the hidden input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Value of the hidden input."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- IMAGE_SUBMIT_TAG =
: HelperEntry
HelperEntry.new( name: "image_submit_tag", type: HelperType::IMAGE_SUBMIT_TAG, source: "ActionView::Helpers::FormTagHelper#image_submit_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Displays an image which when clicked will submit the form.", signature: "image_submit_tag(source, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-image_submit_tag", implicit_attribute: HelperImplicitAttribute.new( "src", "first_arg", nil, "image_path", ["url"] ), arguments: [ HelperArgument.new("source", 1, "string", false, nil, false, "Image source path or URL."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("disabled", "boolean", nil, "If `true`, the submit button is disabled."), ], special_behaviors: [], aliases: [], ).freeze
- LABEL_TAG =
: HelperEntry
HelperEntry.new( name: "label_tag", type: HelperType::LABEL_TAG, source: "ActionView::Helpers::FormTagHelper#label_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "label", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a label element. Accepts a block.", signature: "label_tag(name = nil, content_or_options = nil, options = nil, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-label_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", true, "nil", false, "The for attribute, linking to an input by name."), HelperArgument.new("content_or_options", 2, "string | hash", true, "nil", false, "Label text, or options hash when block is given."), HelperArgument.new("options", 3, "hash", true, "nil", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- MONTH_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "month_field_tag", type: HelperType::MONTH_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#month_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"month\"`.", signature: "month_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-month_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default month value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- NUMBER_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "number_field_tag", type: HelperType::NUMBER_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#number_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a number field.", signature: "number_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-number_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default numeric value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("min", "string | integer", nil, "Minimum allowed value."), HelperOption.new("max", "string | integer", nil, "Maximum allowed value."), HelperOption.new("step", "string | integer", nil, "Step increment."), HelperOption.new("in", "range", nil, "Range of allowed values (sets min, max, and step)."), ], special_behaviors: [], aliases: [], ).freeze
- PASSWORD_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "password_field_tag", type: HelperType::PASSWORD_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#password_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a password field, a masked text field that will hide the user's input behind a mask character.", signature: "password_field_tag(name = \"password\", value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-password_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", true, "password", false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- RADIO_BUTTON_TAG =
: HelperEntry
HelperEntry.new( name: "radio_button_tag", type: HelperType::RADIO_BUTTON_TAG, source: "ActionView::Helpers::FormTagHelper#radio_button_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a radio button form input tag.", signature: "radio_button_tag(name, value, checked = false, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-radio_button_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the radio button."), HelperArgument.new("value", 2, "string", false, nil, false, "Value submitted when selected."), HelperArgument.new("checked", 3, "boolean", true, "false", false, "Whether the radio button is selected by default."), HelperArgument.new("options", 4, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- RANGE_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "range_field_tag", type: HelperType::RANGE_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#range_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a range form element.", signature: "range_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-range_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("min", "string | integer", nil, "Minimum allowed value."), HelperOption.new("max", "string | integer", nil, "Maximum allowed value."), HelperOption.new("step", "string | integer", nil, "Step increment."), HelperOption.new("in", "range", nil, "Range of allowed values (sets min, max, and step)."), ], special_behaviors: [], aliases: [], ).freeze
- SEARCH_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "search_field_tag", type: HelperType::SEARCH_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#search_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"search\"`.", signature: "search_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-search_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SELECT_TAG =
: HelperEntry
HelperEntry.new( name: "select_tag", type: HelperType::SELECT_TAG, source: "ActionView::Helpers::FormTagHelper#select_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "select", is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a dropdown selection box, or if the `:multiple` option is set to `true`, a multiple choice selection box.", signature: "select_tag(name, option_tags = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-select_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the `<select>` element."), HelperArgument.new("option_tags", 2, "string", true, "nil", false, "HTML string of `<option>` tags."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("multiple", "boolean", nil, "If `true`, allows multiple selections."), HelperOption.new("disabled", "boolean", nil, "If `true`, the select is disabled."), HelperOption.new("include_blank", "boolean | string", nil, "Include a blank option at the top."), HelperOption.new("prompt", "string", nil, "Prompt text for the first option."), ], special_behaviors: [], aliases: [], ).freeze
- SUBMIT_TAG =
: HelperEntry
HelperEntry.new( name: "submit_tag", type: HelperType::SUBMIT_TAG, source: "ActionView::Helpers::FormTagHelper#submit_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a submit button with the text value as the caption.", signature: "submit_tag(value = \"Save changes\", options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-submit_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("value", 1, "string", true, "Save changes", false, "Caption text for the submit button."), HelperArgument.new("options", 2, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("disabled", "boolean", nil, "If `true`, the button is disabled."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- TELEPHONE_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "telephone_field_tag", type: HelperType::TELEPHONE_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#telephone_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"tel\"`.", signature: "telephone_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-telephone_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: ["phone_field_tag"], ).freeze
- TEXT_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "text_field_tag", type: HelperType::TEXT_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#text_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.", signature: "text_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-text_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default value for the input."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TEXTAREA_TAG =
: HelperEntry
HelperEntry.new( name: "textarea_tag", type: HelperType::TEXTAREA_TAG, source: "ActionView::Helpers::FormTagHelper#textarea_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "textarea", is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.", signature: "textarea_tag(name, content = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-textarea_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the textarea."), HelperArgument.new("content", 2, "string", true, "nil", false, "Default content of the textarea."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("size", "string", nil, "Textarea dimensions as `\"COLSxROWS\"` (e.g. `\"20x40\"`)."), ], special_behaviors: [], aliases: ["text_area_tag"], ).freeze
- TIME_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "time_field_tag", type: HelperType::TIME_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#time_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"time\"`.", signature: "time_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-time_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default time value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- URL_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "url_field_tag", type: HelperType::URL_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#url_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"url\"`.", signature: "url_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-url_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default URL value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- UTF8_ENFORCER_TAG =
: HelperEntry
HelperEntry.new( name: "utf8_enforcer_tag", type: HelperType::UTF8_ENFORCER_TAG, source: "ActionView::Helpers::FormTagHelper#utf8_enforcer_tag", gem: "actionview", output: :html, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a hidden `<input>` tag that enforces UTF-8 encoding for form submissions.", signature: "utf8_enforcer_tag", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-utf8_enforcer_tag", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- WEEK_FIELD_TAG =
: HelperEntry
HelperEntry.new( name: "week_field_tag", type: HelperType::WEEK_FIELD_TAG, source: "ActionView::Helpers::FormTagHelper#week_field_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "input", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a text field of type `\"week\"`.", signature: "week_field_tag(name, value = nil, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-week_field_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Name attribute for the input."), HelperArgument.new("value", 2, "string", true, "nil", false, "Default week value."), HelperArgument.new("options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- ESCAPE_JAVASCRIPT =
: HelperEntry
HelperEntry.new( name: "escape_javascript", type: HelperType::ESCAPE_JAVASCRIPT, source: "ActionView::Helpers::JavaScriptHelper#escape_javascript", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Escapes carriage returns and single and double quotes for JavaScript segments. Also available as alias `j()`.", signature: "escape_javascript(javascript)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/JavaScriptHelper.html#method-i-escape_javascript", implicit_attribute: nil, arguments: [ HelperArgument.new("javascript", 1, "string", false, nil, false, "JavaScript string to escape."), ], options: [ ], special_behaviors: [], aliases: ["j"], ).freeze
- JAVASCRIPT_CDATA_SECTION =
: HelperEntry
HelperEntry.new( name: "javascript_cdata_section", type: HelperType::JAVASCRIPT_CDATA_SECTION, source: "ActionView::Helpers::JavaScriptHelper#javascript_cdata_section", gem: "actionview", output: :html, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a CDATA section wrapping the given JavaScript content for XHTML compatibility.", signature: "javascript_cdata_section(content)", documentation_url: "", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- JAVASCRIPT_TAG =
: HelperEntry
HelperEntry.new( name: "javascript_tag", type: HelperType::JAVASCRIPT_TAG, source: "ActionView::Helpers::JavaScriptHelper#javascript_tag", gem: "actionview", output: :html, visibility: "public", tag_name: "script", is_void: false, supports_block: true, preferred_for_tag: false, supported: true, detect_style: :call_name, description: "Returns a JavaScript tag with the content inside. Content can be passed as the first argument or captured via a block. Supports an automatic nonce value via `nonce: true` when Content Security Policy is enabled.", signature: "javascript_tag(content_or_options_with_block = nil, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/JavaScriptHelper.html#method-i-javascript_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("content_or_options_with_block", 1, "string | hash", true, "nil", false, "Inline JavaScript content, or options hash when block is given."), HelperArgument.new("html_options", 2, "hash", true, "{}", false, "HTML attributes for the `<script>` tag."), ], options: [ HelperOption.new("nonce", "boolean | string", nil, "CSP nonce value. When `true`, uses the Rails-generated nonce."), HelperOption.new("class", "string", nil, "CSS class name(s)."), ], special_behaviors: [:wrap_body], aliases: [], ).freeze
- NUMBER_TO_CURRENCY =
: HelperEntry
HelperEntry.new( name: "number_to_currency", type: HelperType::NUMBER_TO_CURRENCY, source: "ActionView::Helpers::NumberHelper#number_to_currency", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Formats a number into a currency string.", signature: "number_to_currency(number, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_currency", implicit_attribute: nil, arguments: [ HelperArgument.new("number", 1, "integer | float | string", false, nil, false, "The number to format."), ], options: [ HelperOption.new("unit", "string", nil, "Currency symbol. Defaults to `\"$\"`."), HelperOption.new("precision", "integer", nil, "Number of decimal places. Defaults to 2."), HelperOption.new("delimiter", "string", nil, "Thousands delimiter. Defaults to `\",\"`."), HelperOption.new("separator", "string", nil, "Decimal separator. Defaults to `\".\"`."), ], special_behaviors: [], aliases: [], ).freeze
- NUMBER_TO_HUMAN =
: HelperEntry
HelperEntry.new( name: "number_to_human", type: HelperType::NUMBER_TO_HUMAN, source: "ActionView::Helpers::NumberHelper#number_to_human", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Formats a number into a human-readable representation (e.g. 1.2 Thousand, 1.5 Million).", signature: "number_to_human(number, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_human", implicit_attribute: nil, arguments: [ HelperArgument.new("number", 1, "integer | float", false, nil, false, "The number to format."), ], options: [ HelperOption.new("precision", "integer", nil, "Number of significant digits. Defaults to 3."), HelperOption.new("units", "hash", nil, "Custom unit labels."), ], special_behaviors: [], aliases: [], ).freeze
- NUMBER_TO_HUMAN_SIZE =
: HelperEntry
HelperEntry.new( name: "number_to_human_size", type: HelperType::NUMBER_TO_HUMAN_SIZE, source: "ActionView::Helpers::NumberHelper#number_to_human_size", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Formats the bytes in number into a more human-friendly representation (e.g. 1.2 MB).", signature: "number_to_human_size(number, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_human_size", implicit_attribute: nil, arguments: [ HelperArgument.new("number", 1, "integer", false, nil, false, "The byte count to format."), ], options: [ HelperOption.new("precision", "integer", nil, "Number of significant digits. Defaults to 3."), ], special_behaviors: [], aliases: [], ).freeze
- NUMBER_TO_PERCENTAGE =
: HelperEntry
HelperEntry.new( name: "number_to_percentage", type: HelperType::NUMBER_TO_PERCENTAGE, source: "ActionView::Helpers::NumberHelper#number_to_percentage", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Formats a number as a percentage string.", signature: "number_to_percentage(number, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_percentage", implicit_attribute: nil, arguments: [ HelperArgument.new("number", 1, "integer | float", false, nil, false, "The number to format."), ], options: [ HelperOption.new("precision", "integer", nil, "Number of decimal places. Defaults to 3."), ], special_behaviors: [], aliases: [], ).freeze
- NUMBER_TO_PHONE =
: HelperEntry
HelperEntry.new( name: "number_to_phone", type: HelperType::NUMBER_TO_PHONE, source: "ActionView::Helpers::NumberHelper#number_to_phone", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Formats a number as a phone number.", signature: "number_to_phone(number, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_phone", implicit_attribute: nil, arguments: [ HelperArgument.new("number", 1, "integer | string", false, nil, false, "The phone number to format."), ], options: [ HelperOption.new("area_code", "boolean", nil, "Whether to use area code formatting."), HelperOption.new("delimiter", "string", nil, "Delimiter between digit groups. Defaults to `\"-\"`."), HelperOption.new("country_code", "integer", nil, "Country code to prepend."), HelperOption.new("extension", "integer", nil, "Extension to append."), ], special_behaviors: [], aliases: [], ).freeze
- NUMBER_WITH_DELIMITER =
: HelperEntry
HelperEntry.new( name: "number_with_delimiter", type: HelperType::NUMBER_WITH_DELIMITER, source: "ActionView::Helpers::NumberHelper#number_with_delimiter", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Formats a number with grouped thousands using a delimiter.", signature: "number_with_delimiter(number, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_with_delimiter", implicit_attribute: nil, arguments: [ HelperArgument.new("number", 1, "integer | float", false, nil, false, "The number to format."), ], options: [ HelperOption.new("delimiter", "string", nil, "Thousands delimiter. Defaults to `\",\"`."), HelperOption.new("separator", "string", nil, "Decimal separator. Defaults to `\".\"`."), ], special_behaviors: [], aliases: [], ).freeze
- NUMBER_WITH_PRECISION =
: HelperEntry
HelperEntry.new( name: "number_with_precision", type: HelperType::NUMBER_WITH_PRECISION, source: "ActionView::Helpers::NumberHelper#number_with_precision", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Formats a number with the specified level of precision.", signature: "number_with_precision(number, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_with_precision", implicit_attribute: nil, arguments: [ HelperArgument.new("number", 1, "integer | float", false, nil, false, "The number to format."), ], options: [ HelperOption.new("precision", "integer", nil, "Number of decimal places. Defaults to 3."), HelperOption.new("significant", "boolean", nil, "Whether precision means significant digits."), ], special_behaviors: [], aliases: [], ).freeze
- RAW =
: HelperEntry
HelperEntry.new( name: "raw", type: HelperType::RAW, source: "ActionView::Helpers::OutputSafetyHelper#raw", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Marks a string as trusted safe, bypassing HTML escaping. Use with caution.", signature: "raw(stringish)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/OutputSafetyHelper.html#method-i-raw", implicit_attribute: nil, arguments: [ HelperArgument.new("stringish", 1, "string", false, nil, false, "String to mark as safe."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SAFE_JOIN =
: HelperEntry
HelperEntry.new( name: "safe_join", type: HelperType::SAFE_JOIN, source: "ActionView::Helpers::OutputSafetyHelper#safe_join", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Joins array elements with a separator, HTML-escaping each element but not the separator.", signature: "safe_join(array, sep = $,)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/OutputSafetyHelper.html#method-i-safe_join", implicit_attribute: nil, arguments: [ HelperArgument.new("array", 1, "array", false, nil, false, "Array of elements to join."), HelperArgument.new("sep", 2, "string", true, nil, false, "Separator string."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TO_SENTENCE =
: HelperEntry
HelperEntry.new( name: "to_sentence", type: HelperType::TO_SENTENCE, source: "ActionView::Helpers::OutputSafetyHelper#to_sentence", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Converts an array to a comma-separated sentence where the last element is joined by a connector.", signature: "to_sentence(array, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/OutputSafetyHelper.html#method-i-to_sentence", implicit_attribute: nil, arguments: [ HelperArgument.new("array", 1, "array", false, nil, false, "Array to convert."), ], options: [ HelperOption.new("words_connector", "string", nil, "Connector between words. Defaults to `\", \"`."), HelperOption.new("two_words_connector", "string", nil, "Connector for two words. Defaults to `\" and \"`."), HelperOption.new("last_word_connector", "string", nil, "Connector before last word. Defaults to `\", and \"`."), ], special_behaviors: [], aliases: [], ).freeze
- DOM_CLASS =
: HelperEntry
HelperEntry.new( name: "dom_class", type: HelperType::DOM_CLASS, source: "ActionView::RecordIdentifier#dom_class", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the singular form of a record or class name for use as a DOM class. Can be prefixed for scoping.", signature: "dom_class(record_or_class, prefix = nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/RecordIdentifier.html#method-i-dom_class", implicit_attribute: nil, arguments: [ HelperArgument.new("record_or_class", 1, "object", false, nil, false, "An Active Record instance or class."), HelperArgument.new("prefix", 2, "symbol", true, "nil", false, "Optional prefix for the DOM class (e.g. `:edit`)."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- DOM_ID =
: HelperEntry
HelperEntry.new( name: "dom_id", type: HelperType::DOM_ID, source: "ActionView::RecordIdentifier#dom_id", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a unique DOM id for the record following the convention of the singular form with the id appended. If no id is found, prefixes with `\"new_\"` instead.", signature: "dom_id(record_or_class, prefix = nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/RecordIdentifier.html#method-i-dom_id", implicit_attribute: nil, arguments: [ HelperArgument.new("record_or_class", 1, "object", false, nil, false, "An Active Record instance or class."), HelperArgument.new("prefix", 2, "symbol", true, "nil", false, "Optional prefix for the DOM id (e.g. `:edit`)."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- DOM_TARGET =
: HelperEntry
HelperEntry.new( name: "dom_target", type: HelperType::DOM_TARGET, source: "ActionView::RecordIdentifier#dom_target", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Concatenates any number of parameters into a DOM target string. Records are passed through `dom_id`, while strings and symbols are retained.", signature: "dom_target(*objects)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/RecordIdentifier.html#method-i-dom_target", implicit_attribute: nil, arguments: [ HelperArgument.new("objects", 1, "object", false, nil, true, "Records, strings, or symbols to concatenate."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- MODEL_NAME_FROM_RECORD_OR_CLASS =
: HelperEntry
HelperEntry.new( name: "model_name_from_record_or_class", type: HelperType::MODEL_NAME_FROM_RECORD_OR_CLASS, source: "ActionView::RecordIdentifier#model_name_from_record_or_class", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Extracts the `ActiveModel::Name` from a record instance or class.", signature: "model_name_from_record_or_class", documentation_url: "https://api.rubyonrails.org/classes/ActionView/RecordIdentifier.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- RENDER =
: HelperEntry
HelperEntry.new( name: "render", type: HelperType::RENDER, source: "ActionView::Helpers::RenderingHelper#render", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the result of a `render`. Renders partials, templates, layouts, text, files, or inline templates.", signature: "render(options = {}, locals = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/RenderingHelper.html#method-i-render", implicit_attribute: nil, arguments: [ HelperArgument.new("options", 1, "string | hash | object", true, "{}", false, "Partial name, options hash, or renderable object."), ], options: [ HelperOption.new("partial", "string", nil, "Partial template to render."), HelperOption.new("locals", "hash", nil, "Local variables to pass to the partial."), HelperOption.new("collection", "array", nil, "Collection to render a partial for each item."), HelperOption.new("layout", "string", nil, "Layout to wrap the rendered content."), ], special_behaviors: [], aliases: [], ).freeze
- SANITIZE =
: HelperEntry
HelperEntry.new( name: "sanitize", type: HelperType::SANITIZE, source: "ActionView::Helpers::SanitizeHelper#sanitize", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Sanitizes HTML input, stripping all tags and attributes that are not explicitly allowed.", signature: "sanitize(html, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/SanitizeHelper.html#method-i-sanitize", implicit_attribute: nil, arguments: [ HelperArgument.new("html", 1, "string", false, nil, false, "HTML string to sanitize."), ], options: [ HelperOption.new("tags", "array", nil, "Allowed HTML tags."), HelperOption.new("attributes", "array", nil, "Allowed HTML attributes."), ], special_behaviors: [], aliases: [], ).freeze
- SANITIZE_CSS =
: HelperEntry
HelperEntry.new( name: "sanitize_css", type: HelperType::SANITIZE_CSS, source: "ActionView::Helpers::SanitizeHelper#sanitize_css", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Sanitizes a block of CSS code, removing unsafe properties.", signature: "sanitize_css(style)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/SanitizeHelper.html#method-i-sanitize_css", implicit_attribute: nil, arguments: [ HelperArgument.new("style", 1, "string", false, nil, false, "CSS string to sanitize."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SANITIZER_VENDOR =
: HelperEntry
HelperEntry.new( name: "sanitizer_vendor", type: HelperType::SANITIZER_VENDOR, source: "ActionView::Helpers::SanitizeHelper#sanitizer_vendor", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the HTML sanitizer vendor in use (e.g. `Rails::HTML5::Sanitizer`).", signature: "sanitizer_vendor", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/SanitizeHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- STRIP_LINKS =
: HelperEntry
HelperEntry.new( name: "strip_links", type: HelperType::STRIP_LINKS, source: "ActionView::Helpers::SanitizeHelper#strip_links", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Strips all link tags from text, leaving just the link text.", signature: "strip_links(html)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/SanitizeHelper.html#method-i-strip_links", implicit_attribute: nil, arguments: [ HelperArgument.new("html", 1, "string", false, nil, false, "HTML string to strip links from."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- STRIP_TAGS =
: HelperEntry
HelperEntry.new( name: "strip_tags", type: HelperType::STRIP_TAGS, source: "ActionView::Helpers::SanitizeHelper#strip_tags", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Strips all HTML tags from the input, returning plain text.", signature: "strip_tags(html)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/SanitizeHelper.html#method-i-strip_tags", implicit_attribute: nil, arguments: [ HelperArgument.new("html", 1, "string", false, nil, false, "HTML string to strip tags from."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CDATA_SECTION =
: HelperEntry
HelperEntry.new( name: "cdata_section", type: HelperType::CDATA_SECTION, source: "ActionView::Helpers::TagHelper#cdata_section", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a CDATA section with the given content.", signature: "cdata_section(content)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-cdata_section", implicit_attribute: nil, arguments: [ HelperArgument.new("content", 1, "string", false, nil, false, "Content for the CDATA section."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CONTENT_TAG =
: HelperEntry
HelperEntry.new( name: "content_tag", type: HelperType::CONTENT_TAG, source: "ActionView::Helpers::TagHelper#content_tag", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: true, detect_style: :call_name, description: "Returns an HTML block tag of type name surrounding the content. Add HTML attributes by passing an attributes hash to options. Instead of passing the content as an argument, you can also use a block. This is legacy syntax; see the `tag` method for the modern equivalent.", signature: "content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-content_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string | symbol", false, nil, false, "The HTML tag name (e.g. `:div`, `:span`, `\"p\"`)."), HelperArgument.new("content_or_options_with_block", 2, "string | hash", true, "nil", false, "Tag content string, or options hash when a block is given."), HelperArgument.new("options", 3, "hash", true, "nil", false, "HTML attributes hash."), HelperArgument.new("escape", 4, "boolean", true, "true", false, "Whether to HTML-escape the content."), ], options: [ HelperOption.new("class", "string", nil, "CSS class name(s)."), HelperOption.new("id", "string", nil, "HTML id attribute."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), HelperOption.new("aria", "hash", "aria-*", "Hash of `aria-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- ESCAPE_ONCE =
: HelperEntry
HelperEntry.new( name: "escape_once", type: HelperType::ESCAPE_ONCE, source: "ActionView::Helpers::TagHelper#escape_once", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns an escaped version of HTML without affecting existing escaped entities.", signature: "escape_once(html)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-escape_once", implicit_attribute: nil, arguments: [ HelperArgument.new("html", 1, "string", false, nil, false, "HTML string to escape."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TAG =
: HelperEntry
HelperEntry.new( name: "tag", type: HelperType::TAG, source: "ActionView::Helpers::TagHelper#tag", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: true, detect_style: :receiver_call, description: "Returns an HTML5 compliant tag with a tag proxy. Every tag can be built with `tag.<tag name>(optional content, options)`. Supports `data-*` and `aria-*` attributes via nested hashes. Sub-attributes are dasherized. Respects HTML5 void elements.", signature: "tag.<tag_name>(content = nil, **options, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-tag", implicit_attribute: nil, arguments: [ HelperArgument.new("content", 1, "string", true, "nil", false, "Tag content string."), ], options: [ HelperOption.new("class", "string", nil, "CSS class name(s)."), HelperOption.new("id", "string", nil, "HTML id attribute."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), HelperOption.new("aria", "hash", "aria-*", "Hash of `aria-*` attributes."), ], special_behaviors: [:method_name_underscores_to_dashes], aliases: [], ).freeze
- TOKEN_LIST =
: HelperEntry
HelperEntry.new( name: "token_list", type: HelperType::TOKEN_LIST, source: "ActionView::Helpers::TagHelper#token_list", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a string of space-separated tokens from the arguments. Conditional tokens can be passed as a hash.", signature: "token_list(*args)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-token_list", implicit_attribute: nil, arguments: [ HelperArgument.new("args", 1, "string | hash", false, nil, true, "Tokens to join. Hashes enable conditional inclusion."), ], options: [ ], special_behaviors: [], aliases: ["class_names"], ).freeze
- CONCAT =
: HelperEntry
HelperEntry.new( name: "concat", type: HelperType::CONCAT, source: "ActionView::Helpers::TextHelper#concat", gem: "actionview", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Appends text to the output buffer. Used inside non-output code blocks (`<% %>`) as an alternative to the output syntax (`<%= %>`).", signature: "concat(string)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-concat", implicit_attribute: nil, arguments: [ HelperArgument.new("string", 1, "string", false, nil, false, "The text to append to the output buffer."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CURRENT_CYCLE =
: HelperEntry
HelperEntry.new( name: "current_cycle", type: HelperType::CURRENT_CYCLE, source: "ActionView::Helpers::TextHelper#current_cycle", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the current cycle string after a cycle has been started. Useful for complex table highlighting or any other design need which requires the current cycle string in more than one place.", signature: "current_cycle(name = \"default\")", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-current_cycle", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", true, "\"default\"", false, "Name of the cycle to return the current value for."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CYCLE =
: HelperEntry
HelperEntry.new( name: "cycle", type: HelperType::CYCLE, source: "ActionView::Helpers::TextHelper#cycle", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a Cycle object whose `to_s` method cycles through elements of an array every time it is called.", signature: "cycle(first_value, *values)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-cycle", implicit_attribute: nil, arguments: [ HelperArgument.new("first_value", 1, "string", false, nil, false, "First value in the cycle."), HelperArgument.new("values", 2, "string", true, nil, true, "Additional values to cycle through."), ], options: [ HelperOption.new("name", "string", nil, "Name for the cycle. Defaults to `\"default\"`."), ], special_behaviors: [], aliases: [], ).freeze
- EXCERPT =
: HelperEntry
HelperEntry.new( name: "excerpt", type: HelperType::EXCERPT, source: "ActionView::Helpers::TextHelper#excerpt", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Extracts an excerpt from text that matches the first instance of a phrase.", signature: "excerpt(text, phrase, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-excerpt", implicit_attribute: nil, arguments: [ HelperArgument.new("text", 1, "string", false, nil, false, "The text to excerpt from."), HelperArgument.new("phrase", 2, "string", false, nil, false, "The phrase to center the excerpt around."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options hash."), ], options: [ HelperOption.new("radius", "integer", nil, "Number of characters around the phrase. Defaults to 100."), HelperOption.new("omission", "string", nil, "Omission string. Defaults to `\"...\"`."), ], special_behaviors: [], aliases: [], ).freeze
- HIGHLIGHT =
: HelperEntry
HelperEntry.new( name: "highlight", type: HelperType::HIGHLIGHT, source: "ActionView::Helpers::TextHelper#highlight", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Highlights occurrences of phrases in text by inserting a highlight tag around them.", signature: "highlight(text, phrases, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-highlight", implicit_attribute: nil, arguments: [ HelperArgument.new("text", 1, "string", false, nil, false, "The text to search."), HelperArgument.new("phrases", 2, "string | array", false, nil, false, "Phrase(s) to highlight."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options hash."), ], options: [ HelperOption.new("highlighter", "string", nil, "HTML tag to wrap highlights in. Defaults to `<mark>`."), ], special_behaviors: [], aliases: [], ).freeze
- PLURALIZE =
: HelperEntry
HelperEntry.new( name: "pluralize", type: HelperType::PLURALIZE, source: "ActionView::Helpers::TextHelper#pluralize", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Attempts to pluralize the singular word unless count is 1. Returns the count followed by the pluralized word.", signature: "pluralize(count, singular, plural_arg = nil, plural: plural_arg, locale: I18n.locale)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-pluralize", implicit_attribute: nil, arguments: [ HelperArgument.new("count", 1, "integer", false, nil, false, "The count to determine pluralization."), HelperArgument.new("singular", 2, "string", false, nil, false, "The singular form of the word."), ], options: [ HelperOption.new("plural", "string", nil, "Explicit plural form to use."), HelperOption.new("locale", "symbol", nil, "Locale for pluralization rules."), ], special_behaviors: [], aliases: [], ).freeze
- RESET_CYCLE =
: HelperEntry
HelperEntry.new( name: "reset_cycle", type: HelperType::RESET_CYCLE, source: "ActionView::Helpers::TextHelper#reset_cycle", gem: "actionview", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Resets a cycle so that it starts from the first element the next time it is called. Pass in `name` to reset a named cycle.", signature: "reset_cycle(name = \"default\")", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-reset_cycle", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", true, "\"default\"", false, "Name of the cycle to reset."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SAFE_CONCAT =
: HelperEntry
HelperEntry.new( name: "safe_concat", type: HelperType::SAFE_CONCAT, source: "ActionView::Helpers::TextHelper#safe_concat", gem: "actionview", output: :void, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Concatenates a string to the output buffer without HTML escaping. The string must already be `html_safe`.", signature: "safe_concat(string)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-safe_concat", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- SIMPLE_FORMAT =
: HelperEntry
HelperEntry.new( name: "simple_format", type: HelperType::SIMPLE_FORMAT, source: "ActionView::Helpers::TextHelper#simple_format", gem: "actionview", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Converts text to HTML using simple formatting rules. Returns text wrapped in paragraph tags with line breaks converted to `<br>` tags.", signature: "simple_format(text, html_options = {}, options = {})", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-simple_format", implicit_attribute: nil, arguments: [ HelperArgument.new("text", 1, "string", false, nil, false, "The text to format."), HelperArgument.new("html_options", 2, "hash", true, "{}", false, "HTML attributes for the wrapper paragraph tags."), HelperArgument.new("options", 3, "hash", true, "{}", false, "Options hash. Supports `:sanitize` and `:wrapper_tag`."), ], options: [ HelperOption.new("sanitize", "boolean", nil, "Whether to sanitize the text. Defaults to `true`."), HelperOption.new("wrapper_tag", "string", nil, "HTML tag to wrap paragraphs in. Defaults to `\"p\"`."), ], special_behaviors: [], aliases: [], ).freeze
- TRUNCATE =
: HelperEntry
HelperEntry.new( name: "truncate", type: HelperType::TRUNCATE, source: "ActionView::Helpers::TextHelper#truncate", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Truncates text to a specified length and appends an omission string.", signature: "truncate(text, options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-truncate", implicit_attribute: nil, arguments: [ HelperArgument.new("text", 1, "string", false, nil, false, "The text to truncate."), HelperArgument.new("options", 2, "hash", true, "{}", false, "Options hash."), ], options: [ HelperOption.new("length", "integer", nil, "Maximum length. Defaults to 30."), HelperOption.new("omission", "string", nil, "Omission string. Defaults to `\"...\"`."), HelperOption.new("separator", "string", nil, "Truncate at a natural break near the length limit."), HelperOption.new("escape", "boolean", nil, "Whether to HTML-escape the result. Defaults to `true`."), ], special_behaviors: [], aliases: [], ).freeze
- WORD_WRAP =
: HelperEntry
HelperEntry.new( name: "word_wrap", type: HelperType::WORD_WRAP, source: "ActionView::Helpers::TextHelper#word_wrap", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Wraps text into lines no longer than the specified `line_width`.", signature: "word_wrap(text, line_width: 80, break_sequence: \" \")", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-word_wrap", implicit_attribute: nil, arguments: [ HelperArgument.new("text", 1, "string", false, nil, false, "The text to wrap."), ], options: [ HelperOption.new("line_width", "integer", nil, "Maximum line width. Defaults to 80."), HelperOption.new("break_sequence", "string", nil, "Line break sequence. Defaults to newline."), ], special_behaviors: [], aliases: [], ).freeze
- DEBUG_MISSING_TRANSLATION =
: HelperEntry
HelperEntry.new( name: "debug_missing_translation", type: HelperType::DEBUG_MISSING_TRANSLATION, source: "ActionView::Helpers::TranslationHelper#debug_missing_translation", gem: "actionview", output: :text, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether missing translations show debug markup instead of raising.", signature: "debug_missing_translation", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TranslationHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- LOCALIZE =
: HelperEntry
HelperEntry.new( name: "localize", type: HelperType::LOCALIZE, source: "ActionView::Helpers::TranslationHelper#localize", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Delegates to `I18n.localize` with no additional functionality. Also available as `l()`.", signature: "localize(object, **options)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TranslationHelper.html#method-i-localize", implicit_attribute: nil, arguments: [ HelperArgument.new("object", 1, "object", false, nil, false, "Date, Time, or Number to localize."), ], options: [ HelperOption.new("format", "symbol", nil, "Format for the localized output."), HelperOption.new("locale", "symbol", nil, "Locale to use."), ], special_behaviors: [], aliases: ["l"], ).freeze
- TRANSLATE =
: HelperEntry
HelperEntry.new( name: "translate", type: HelperType::TRANSLATE, source: "ActionView::Helpers::TranslationHelper#translate", gem: "actionview", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Delegates to `I18n#translate` but also performs key scoping relative to the current view template. Also available as `t()`.", signature: "translate(key, **options)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/TranslationHelper.html#method-i-translate", implicit_attribute: nil, arguments: [ HelperArgument.new("key", 1, "string | symbol", false, nil, false, "Translation key."), ], options: [ HelperOption.new("default", "string | array", nil, "Default value if key is missing."), HelperOption.new("scope", "string | array", nil, "Scope for the translation key."), HelperOption.new("count", "integer", nil, "Count for pluralization."), ], special_behaviors: [], aliases: ["t"], ).freeze
- BUTTON_TO =
: HelperEntry
HelperEntry.new( name: "button_to", type: HelperType::BUTTON_TO, source: "ActionView::Helpers::UrlHelper#button_to", gem: "actionview", output: :html, visibility: "public", tag_name: "form", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Generates a form containing a single button that submits to the URL created by the set of options. This is the safest method to ensure links that cause changes to your data are not triggered by search bots or accelerators.", signature: "button_to(name = nil, options = nil, html_options = nil, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-button_to", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", true, "nil", false, "Button label text."), HelperArgument.new("options", 2, "string | hash", true, "nil", false, "URL string or `url_for` options hash."), HelperArgument.new("html_options", 3, "hash", true, "nil", false, "HTML attributes hash."), ], options: [ HelperOption.new("method", "symbol", nil, "HTTP verb. Supported verbs are `:post`, `:get`, `:delete`, `:patch`, and `:put`. Defaults to `:post`."), HelperOption.new("disabled", "boolean", nil, "If set to `true`, generates a disabled button."), HelperOption.new("form_class", "string", nil, "CSS class for the form element. Defaults to `\"button_to\"`."), HelperOption.new("params", "hash", nil, "Hash of parameters to be rendered as hidden fields within the form."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- BUTTON_TO_GENERATES_BUTTON_TAG =
: HelperEntry
HelperEntry.new( name: "button_to_generates_button_tag", type: HelperType::BUTTON_TO_GENERATES_BUTTON_TAG, source: "ActionView::Helpers::UrlHelper#button_to_generates_button_tag", gem: "actionview", output: :boolean, visibility: "internal", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns whether `button_to` generates a `<button>` element instead of an `<input type=\"submit\">`.", signature: "button_to_generates_button_tag", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- CURRENT_PAGE_P =
: HelperEntry
HelperEntry.new( name: "current_page?", type: HelperType::CURRENT_PAGE_P, source: "ActionView::Helpers::UrlHelper#current_page?", gem: "actionview", output: :boolean, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns `true` if the current request URI matches the given URL. Useful for highlighting active navigation.", signature: "current_page?(options = nil, check_parameters: false, method: :get)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-current_page-3F", implicit_attribute: nil, arguments: [ HelperArgument.new("options", 1, "string | hash", true, "nil", false, "URL string or `url_for` options hash to compare against."), ], options: [ HelperOption.new("check_parameters", "boolean", nil, "Whether to include query parameters in the comparison."), HelperOption.new("method", "symbol", nil, "HTTP method to check. Defaults to `:get`."), ], special_behaviors: [], aliases: [], ).freeze
- LINK_TO =
: HelperEntry
HelperEntry.new( name: "link_to", type: HelperType::LINK_TO, source: "ActionView::Helpers::UrlHelper#link_to", gem: "actionview", output: :html, visibility: "public", tag_name: "a", is_void: false, supports_block: true, preferred_for_tag: true, supported: true, detect_style: :call_name, description: "Creates an anchor element of the given name using a URL created by the set of options. It is also possible to pass a String instead of an options hash, which generates an anchor element that uses the value of the String as the href for the link. If `nil` is passed as the name the value of the link itself will become the name.", signature: "link_to(name = nil, options = nil, html_options = nil, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to", implicit_attribute: HelperImplicitAttribute.new( "href", "second_arg", "first_arg", "url_for", ["string", "route_helper"] ), arguments: [ HelperArgument.new("name", 1, "string", true, "nil", false, "Link text. When a block is given, this becomes the URL instead."), HelperArgument.new("options", 2, "string | hash", true, "nil", false, "URL string, route helper, or `url_for` options hash."), HelperArgument.new("html_options", 3, "hash", true, "nil", false, "HTML attributes hash."), ], options: [ HelperOption.new("method", "symbol", "data-method", "HTTP verb for the link (e.g. `:delete`, `:patch`). Rendered as a `data-method` attribute."), HelperOption.new("remote", "boolean", "data-remote", "If `true`, link submits via Ajax. Rendered as a `data-remote` attribute."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), HelperOption.new("class", "string", nil, "CSS class name(s)."), HelperOption.new("id", "string", nil, "HTML id attribute."), ], special_behaviors: [:implied_attribute], aliases: [], ).freeze
- LINK_TO_IF =
: HelperEntry
HelperEntry.new( name: "link_to_if", type: HelperType::LINK_TO_IF, source: "ActionView::Helpers::UrlHelper#link_to_if", gem: "actionview", output: :html, visibility: "public", tag_name: "a", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a link tag of the given name using a URL created by the set of options if condition is true, otherwise only the name is returned. To specialize the default behavior, you can pass a block.", signature: "link_to_if(condition, name, options = {}, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to_if", implicit_attribute: nil, arguments: [ HelperArgument.new("condition", 1, "boolean", false, nil, false, "Condition to evaluate. Link is rendered only if truthy."), HelperArgument.new("name", 2, "string", false, nil, false, "Link text."), HelperArgument.new("options", 3, "string | hash", true, "{}", false, "URL string or `url_for` options hash."), HelperArgument.new("html_options", 4, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- LINK_TO_UNLESS =
: HelperEntry
HelperEntry.new( name: "link_to_unless", type: HelperType::LINK_TO_UNLESS, source: "ActionView::Helpers::UrlHelper#link_to_unless", gem: "actionview", output: :html, visibility: "public", tag_name: "a", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a link tag of the given name using a URL created by the set of options unless condition is true, in which case only the name is returned. To specialize the default behavior, you can pass a block.", signature: "link_to_unless(condition, name, options = {}, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to_unless", implicit_attribute: nil, arguments: [ HelperArgument.new("condition", 1, "boolean", false, nil, false, "Condition to evaluate. Link is rendered only if falsy."), HelperArgument.new("name", 2, "string", false, nil, false, "Link text."), HelperArgument.new("options", 3, "string | hash", true, "{}", false, "URL string or `url_for` options hash."), HelperArgument.new("html_options", 4, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- LINK_TO_UNLESS_CURRENT =
: HelperEntry
HelperEntry.new( name: "link_to_unless_current", type: HelperType::LINK_TO_UNLESS_CURRENT, source: "ActionView::Helpers::UrlHelper#link_to_unless_current", gem: "actionview", output: :html, visibility: "public", tag_name: "a", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a link tag of the given name using a URL created by the set of options unless the current request URI is the same as the link's, in which case only the name is returned or the given block is yielded.", signature: "link_to_unless_current(name, options = {}, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to_unless_current", implicit_attribute: nil, arguments: [ HelperArgument.new("name", 1, "string", false, nil, false, "Link text."), HelperArgument.new("options", 2, "string | hash", true, "{}", false, "URL string or `url_for` options hash."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- MAIL_TO =
: HelperEntry
HelperEntry.new( name: "mail_to", type: HelperType::MAIL_TO, source: "ActionView::Helpers::UrlHelper#mail_to", gem: "actionview", output: :html, visibility: "public", tag_name: "a", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a mailto link tag to the specified email_address, which is also used as the name of the link unless name is specified. Additional HTML attributes for the link can be passed in html_options.", signature: "mail_to(email_address, name = nil, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-mail_to", implicit_attribute: HelperImplicitAttribute.new( "href", "first_arg", nil, "", [] ), arguments: [ HelperArgument.new("email_address", 1, "string", false, nil, false, "The email address for the mailto link."), HelperArgument.new("name", 2, "string", true, "nil", false, "Link text. Defaults to the email address."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("subject", "string", nil, "Preset subject line for the email."), HelperOption.new("body", "string", nil, "Preset body for the email."), HelperOption.new("cc", "string", nil, "Carbon copy recipients."), HelperOption.new("bcc", "string", nil, "Blind carbon copy recipients."), HelperOption.new("reply_to", "string", nil, "Preset the Reply-To field of the email."), ], special_behaviors: [], aliases: [], ).freeze
- PHONE_TO =
: HelperEntry
HelperEntry.new( name: "phone_to", type: HelperType::PHONE_TO, source: "ActionView::Helpers::UrlHelper#phone_to", gem: "actionview", output: :html, visibility: "public", tag_name: "a", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a TEL anchor link tag to the specified phone_number. When the link is clicked, the default app to make phone calls is opened and prepopulated with the phone number.", signature: "phone_to(phone_number, name = nil, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-phone_to", implicit_attribute: HelperImplicitAttribute.new( "href", "first_arg", nil, "", [] ), arguments: [ HelperArgument.new("phone_number", 1, "string", false, nil, false, "The phone number for the tel link."), HelperArgument.new("name", 2, "string", true, "nil", false, "Link text. Defaults to the phone number."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("country_code", "string", nil, "Prepends a plus sign and the given country code to the phone number."), ], special_behaviors: [], aliases: [], ).freeze
- SMS_TO =
: HelperEntry
HelperEntry.new( name: "sms_to", type: HelperType::SMS_TO, source: "ActionView::Helpers::UrlHelper#sms_to", gem: "actionview", output: :html, visibility: "public", tag_name: "a", is_void: false, supports_block: true, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates an SMS anchor link tag to the specified phone_number. When the link is clicked, the default SMS messaging app is opened ready to send a message. If the body option is specified, the contents of the message will be preset.", signature: "sms_to(phone_number, name = nil, html_options = {}, &block)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-sms_to", implicit_attribute: HelperImplicitAttribute.new( "href", "first_arg", nil, "", [] ), arguments: [ HelperArgument.new("phone_number", 1, "string", false, nil, false, "The phone number for the SMS link."), HelperArgument.new("name", 2, "string", true, "nil", false, "Link text. Defaults to the phone number."), HelperArgument.new("html_options", 3, "hash", true, "{}", false, "HTML attributes hash."), ], options: [ HelperOption.new("country_code", "string", nil, "Prepends a plus sign and the given country code to the phone number."), HelperOption.new("body", "string", nil, "Preset the body of the SMS message."), ], special_behaviors: [], aliases: [], ).freeze
- URL_FOR =
: HelperEntry
HelperEntry.new( name: "url_for", type: HelperType::URL_FOR, source: "ActionView::Helpers::UrlHelper#url_for", gem: "actionview", output: :url, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns the URL for the set of options provided.", signature: "url_for(options = nil)", documentation_url: "https://api.rubyonrails.org/classes/ActionView/RoutingUrlFor.html#method-i-url_for", implicit_attribute: nil, arguments: [ HelperArgument.new("options", 1, "string | hash", true, "nil", false, "URL string or `url_for` options hash."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_EXEMPTS_PAGE_FROM_CACHE =
: HelperEntry
HelperEntry.new( name: "turbo_exempts_page_from_cache", type: HelperType::TURBO_EXEMPTS_PAGE_FROM_CACHE, source: "Turbo::DriveHelper#turbo_exempts_page_from_cache", gem: "turbo-rails", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Pages that are more likely than not to be a cache miss can skip turbo cache to avoid visual jitter. Cannot be used along with `turbo_exempts_page_from_preview`.", signature: "turbo_exempts_page_from_cache", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_exempts_page_from_cache-instance_method", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_EXEMPTS_PAGE_FROM_CACHE_TAG =
: HelperEntry
HelperEntry.new( name: "turbo_exempts_page_from_cache_tag", type: HelperType::TURBO_EXEMPTS_PAGE_FROM_CACHE_TAG, source: "Turbo::DriveHelper#turbo_exempts_page_from_cache_tag", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "meta", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<meta>` tag with `name=\"turbo-cache-control\" content=\"no-cache\"`. Pages that are more likely than not to be a cache miss can skip turbo cache to avoid visual jitter.", signature: "turbo_exempts_page_from_cache_tag", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_exempts_page_from_cache_tag-instance_method", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_EXEMPTS_PAGE_FROM_PREVIEW =
: HelperEntry
HelperEntry.new( name: "turbo_exempts_page_from_preview", type: HelperType::TURBO_EXEMPTS_PAGE_FROM_PREVIEW, source: "Turbo::DriveHelper#turbo_exempts_page_from_preview", gem: "turbo-rails", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Specify that a cached version of the page should not be shown as a preview during an application visit. Cannot be used along with `turbo_exempts_page_from_cache`.", signature: "turbo_exempts_page_from_preview", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_exempts_page_from_preview-instance_method", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_EXEMPTS_PAGE_FROM_PREVIEW_TAG =
: HelperEntry
HelperEntry.new( name: "turbo_exempts_page_from_preview_tag", type: HelperType::TURBO_EXEMPTS_PAGE_FROM_PREVIEW_TAG, source: "Turbo::DriveHelper#turbo_exempts_page_from_preview_tag", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "meta", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<meta>` tag with `name=\"turbo-cache-control\" content=\"no-preview\"`. Specifies that a cached version of the page should not be shown as a preview during an application visit.", signature: "turbo_exempts_page_from_preview_tag", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_exempts_page_from_preview_tag-instance_method", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_PAGE_REQUIRES_RELOAD =
: HelperEntry
HelperEntry.new( name: "turbo_page_requires_reload", type: HelperType::TURBO_PAGE_REQUIRES_RELOAD, source: "Turbo::DriveHelper#turbo_page_requires_reload", gem: "turbo-rails", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Force the page, when loaded by Turbo, to cause a full page reload.", signature: "turbo_page_requires_reload", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_page_requires_reload-instance_method", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_PAGE_REQUIRES_RELOAD_TAG =
: HelperEntry
HelperEntry.new( name: "turbo_page_requires_reload_tag", type: HelperType::TURBO_PAGE_REQUIRES_RELOAD_TAG, source: "Turbo::DriveHelper#turbo_page_requires_reload_tag", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "meta", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<meta>` tag with `name=\"turbo-visit-control\" content=\"reload\"`. Forces the page, when loaded by Turbo, to cause a full page reload.", signature: "turbo_page_requires_reload_tag", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_page_requires_reload_tag-instance_method", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_REFRESH_METHOD_TAG =
: HelperEntry
HelperEntry.new( name: "turbo_refresh_method_tag", type: HelperType::TURBO_REFRESH_METHOD_TAG, source: "Turbo::DriveHelper#turbo_refresh_method_tag", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "meta", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<meta>` tag with `name=\"turbo-refresh-method\"`. Configures method to perform page refreshes. Can be `:replace` (default) or `:morph`.", signature: "turbo_refresh_method_tag(method = :replace)", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_refresh_method_tag-instance_method", implicit_attribute: nil, arguments: [ HelperArgument.new("method", 1, "symbol", true, ":replace", false, "Refresh method (`:replace` or `:morph`)."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_REFRESH_SCROLL_TAG =
: HelperEntry
HelperEntry.new( name: "turbo_refresh_scroll_tag", type: HelperType::TURBO_REFRESH_SCROLL_TAG, source: "Turbo::DriveHelper#turbo_refresh_scroll_tag", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "meta", is_void: true, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `<meta>` tag with `name=\"turbo-refresh-scroll\"`. Configures scroll strategy for page refreshes. Can be `:reset` (default) or `:preserve`.", signature: "turbo_refresh_scroll_tag(scroll = :reset)", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_refresh_scroll_tag-instance_method", implicit_attribute: nil, arguments: [ HelperArgument.new("scroll", 1, "symbol", true, ":reset", false, "Scroll strategy (`:reset` or `:preserve`)."), ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_REFRESHES_WITH =
: HelperEntry
HelperEntry.new( name: "turbo_refreshes_with", type: HelperType::TURBO_REFRESHES_WITH, source: "Turbo::DriveHelper#turbo_refreshes_with", gem: "turbo-rails", output: :void, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Configure how to handle page refreshes. Calls `turbo_refresh_method_tag` and `turbo_refresh_scroll_tag` and provides them to the `:head` content block.", signature: "turbo_refreshes_with(method: :replace, scroll: :reset)", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/DriveHelper#turbo_refreshes_with-instance_method", implicit_attribute: nil, arguments: [ ], options: [ HelperOption.new("method", "symbol", nil, "Method to update the body during a page refresh. Can be `:replace` (default) or `:morph`."), HelperOption.new("scroll", "symbol", nil, "Scroll behavior during a page refresh. Can be `:reset` (default) or `:preserve`."), ], special_behaviors: [], aliases: [], ).freeze
- TURBO_FRAME_TAG =
: HelperEntry
HelperEntry.new( name: "turbo_frame_tag", type: HelperType::TURBO_FRAME_TAG, source: "Turbo::FramesHelper#turbo_frame_tag", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "turbo-frame", is_void: false, supports_block: true, preferred_for_tag: true, supported: true, detect_style: :call_name, description: "Returns a `<turbo-frame>` element. The first argument becomes the id attribute. Non-string and non-symbol values are automatically wrapped in `dom_id()`.", signature: "turbo_frame_tag(*ids, src: nil, target: nil, **attributes, &block)", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/FramesHelper:turbo_frame_tag", implicit_attribute: HelperImplicitAttribute.new( "id", "first_arg", nil, "dom_id", ["string", "symbol", "dom_id_call"] ), arguments: [ HelperArgument.new("ids", 1, "string | symbol | object", false, nil, true, "Frame ID or object(s) passed to `dom_id`."), ], options: [ HelperOption.new("src", "string", nil, "URL to lazy-load the frame content from."), HelperOption.new("target", "string", nil, "Target frame for navigation (_top or a frame id)."), HelperOption.new("loading", "symbol", nil, "Loading strategy (`:eager` or `:lazy`)."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- TURBO_INCLUDE_TAGS =
: HelperEntry
HelperEntry.new( name: "turbo_include_tags", type: HelperType::TURBO_INCLUDE_TAGS, source: "Turbo::IncludesHelper#turbo_include_tags", gem: "turbo-rails", output: :html, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Deprecated. Returns a `<script>` tag to include the Turbo JavaScript. Use `javascript_include_tag \"turbo\", type: \"module\"` directly instead.", signature: "turbo_include_tags", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/IncludesHelper#turbo_include_tags-instance_method", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_STREAM_ACTION_TAG =
: HelperEntry
HelperEntry.new( name: "turbo_stream_action_tag", type: HelperType::TURBO_STREAM_ACTION_TAG, source: "Turbo::Streams::ActionHelper#turbo_stream_action_tag", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "turbo-stream", is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a `<turbo-stream>` element with the specified action. Accepts `target:` or `targets:` to identify the DOM element(s) to act on, and `template:` for the inner HTML content.", signature: "turbo_stream_action_tag(action, target: nil, targets: nil, template: nil, **attributes)", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/Streams/ActionHelper:turbo_stream_action_tag", implicit_attribute: nil, arguments: [ HelperArgument.new("action", 1, "string | symbol", false, nil, false, "The Turbo Stream action (e.g. `\"remove\"`, `\"replace\"`, `\"append\"`)."), ], options: [ HelperOption.new("target", "string | object", nil, "The DOM ID of the target element. Objects are passed through `dom_id`."), HelperOption.new("targets", "string", nil, "A CSS selector to target multiple elements."), HelperOption.new("template", "string", nil, "The inner HTML content wrapped in a `<template>` element."), ], special_behaviors: [], aliases: [], ).freeze
- TURBO_STREAM_REFRESH_TAG =
: HelperEntry
HelperEntry.new( name: "turbo_stream_refresh_tag", type: HelperType::TURBO_STREAM_REFRESH_TAG, source: "Turbo::Streams::ActionHelper#turbo_stream_refresh_tag", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "turbo-stream", is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Creates a `<turbo-stream>` element with `action=\"refresh\"`. Delegates to `turbo_stream_action_tag` with the `:refresh` action.", signature: "turbo_stream_refresh_tag(request_id: Turbo.current_request_id, **attributes)", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/Streams/ActionHelper:turbo_stream_refresh_tag", implicit_attribute: nil, arguments: [ ], options: [ HelperOption.new("request_id", "string", nil, "The request ID for the refresh. Defaults to `Turbo.current_request_id`."), ], special_behaviors: [], aliases: [], ).freeze
- TURBO_STREAM =
: HelperEntry
HelperEntry.new( name: "turbo_stream", type: HelperType::TURBO_STREAM, source: "Turbo::StreamsHelper#turbo_stream", gem: "turbo-rails", output: :text, visibility: "public", tag_name: nil, is_void: false, supports_block: false, preferred_for_tag: false, supported: false, detect_style: :call_name, description: "Returns a `Turbo::Streams::TagBuilder` instance for constructing Turbo Stream responses. Used in `.turbo_stream.erb` templates to build stream actions.", signature: "turbo_stream", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/StreamsHelper#turbo_stream-instance_method", implicit_attribute: nil, arguments: [ ], options: [ ], special_behaviors: [], aliases: [], ).freeze
- TURBO_STREAM_FROM =
: HelperEntry
HelperEntry.new( name: "turbo_stream_from", type: HelperType::TURBO_STREAM_FROM, source: "Turbo::StreamsHelper#turbo_stream_from", gem: "turbo-rails", output: :html, visibility: "public", tag_name: "turbo-cable-stream-source", is_void: true, supports_block: false, preferred_for_tag: true, supported: false, detect_style: :call_name, description: "Renders a `<turbo-cable-stream-source>` custom element that connects to an Action Cable channel for Turbo Stream broadcasts.", signature: "turbo_stream_from(*streamables, **attributes)", documentation_url: "https://www.rubydoc.info/github/hotwired/turbo-rails/Turbo/StreamsHelper:turbo_stream_from", implicit_attribute: nil, arguments: [ HelperArgument.new("streamables", 1, "object", false, nil, true, "One or more streamable objects or channel names."), ], options: [ HelperOption.new("channel", "string", nil, "Action Cable channel name."), HelperOption.new("data", "hash", "data-*", "Hash of `data-*` attributes."), ], special_behaviors: [], aliases: [], ).freeze
- ENTRIES =
: HelperEntry
{ "action_cable_meta_tag" => ACTION_CABLE_META_TAG, "content_security_policy?" => CONTENT_SECURITY_POLICY_P, "content_security_policy_nonce" => CONTENT_SECURITY_POLICY_NONCE, "polymorphic_path" => POLYMORPHIC_PATH, "polymorphic_url" => POLYMORPHIC_URL, "form_authenticity_token" => FORM_AUTHENTICITY_TOKEN, "protect_against_forgery?" => PROTECT_AGAINST_FORGERY_P, "render_action_text_content" => RENDER_ACTION_TEXT_CONTENT, "sanitize_action_text_content" => SANITIZE_ACTION_TEXT_CONTENT, "rich_textarea_tag" => RICH_TEXTAREA_TAG, "error_message" => ERROR_MESSAGE, "error_wrapping" => ERROR_WRAPPING, "object" => OBJECT, "apply_stylesheet_media_default" => APPLY_STYLESHEET_MEDIA_DEFAULT, "audio_tag" => AUDIO_TAG, "auto_discovery_link_tag" => AUTO_DISCOVERY_LINK_TAG, "auto_include_nonce" => AUTO_INCLUDE_NONCE, "auto_include_nonce_for_scripts" => AUTO_INCLUDE_NONCE_FOR_SCRIPTS, "auto_include_nonce_for_styles" => AUTO_INCLUDE_NONCE_FOR_STYLES, "favicon_link_tag" => FAVICON_LINK_TAG, "image_decoding" => IMAGE_DECODING, "image_loading" => IMAGE_LOADING, "image_tag" => IMAGE_TAG, "javascript_include_tag" => JAVASCRIPT_INCLUDE_TAG, "picture_tag" => PICTURE_TAG, "preload_link_tag" => PRELOAD_LINK_TAG, "preload_links_header" => PRELOAD_LINKS_HEADER, "stylesheet_link_tag" => STYLESHEET_LINK_TAG, "video_tag" => VIDEO_TAG, "asset_path" => ASSET_PATH, "path_to_asset" => ASSET_PATH, "asset_url" => ASSET_URL, "url_to_asset" => ASSET_URL, "audio_path" => AUDIO_PATH, "path_to_audio" => AUDIO_PATH, "audio_url" => AUDIO_URL, "url_to_audio" => AUDIO_URL, "compute_asset_extname" => COMPUTE_ASSET_EXTNAME, "compute_asset_host" => COMPUTE_ASSET_HOST, "compute_asset_path" => COMPUTE_ASSET_PATH, "font_path" => FONT_PATH, "path_to_font" => FONT_PATH, "font_url" => FONT_URL, "url_to_font" => FONT_URL, "image_path" => IMAGE_PATH, "path_to_image" => IMAGE_PATH, "image_url" => IMAGE_URL, "url_to_image" => IMAGE_URL, "javascript_path" => JAVASCRIPT_PATH, "path_to_javascript" => JAVASCRIPT_PATH, "javascript_url" => JAVASCRIPT_URL, "url_to_javascript" => JAVASCRIPT_URL, "public_compute_asset_path" => PUBLIC_COMPUTE_ASSET_PATH, "stylesheet_path" => STYLESHEET_PATH, "path_to_stylesheet" => STYLESHEET_PATH, "stylesheet_url" => STYLESHEET_URL, "url_to_stylesheet" => STYLESHEET_URL, "video_path" => VIDEO_PATH, "path_to_video" => VIDEO_PATH, "video_url" => VIDEO_URL, "url_to_video" => VIDEO_URL, "atom_feed" => ATOM_FEED, "cache" => CACHE, "cache_fragment_name" => CACHE_FRAGMENT_NAME, "cache_if" => CACHE_IF, "cache_unless" => CACHE_UNLESS, "caching?" => CACHING_P, "digest_path_from_template" => DIGEST_PATH_FROM_TEMPLATE, "fragment_for" => FRAGMENT_FOR, "fragment_name_with_digest" => FRAGMENT_NAME_WITH_DIGEST, "read_fragment_for" => READ_FRAGMENT_FOR, "uncacheable!" => UNCACHEABLE_BANG, "write_fragment_for" => WRITE_FRAGMENT_FOR, "capture" => CAPTURE, "content_for" => CONTENT_FOR, "content_for?" => CONTENT_FOR_P, "provide" => PROVIDE, "with_output_buffer" => WITH_OUTPUT_BUFFER, "prepend_content_exfiltration_prevention" => PREPEND_CONTENT_EXFILTRATION_PREVENTION, "prevent_content_exfiltration" => PREVENT_CONTENT_EXFILTRATION, "action_name" => ACTION_NAME, "assign_controller" => ASSIGN_CONTROLLER, "controller" => CONTROLLER, "controller_name" => CONTROLLER_NAME, "controller_path" => CONTROLLER_PATH, "cookies" => COOKIES, "flash" => FLASH, "headers" => HEADERS, "logger" => LOGGER, "logger?" => LOGGER, "params" => PARAMS, "request" => REQUEST, "request_forgery_protection_token" => REQUEST_FORGERY_PROTECTION_TOKEN, "response" => RESPONSE, "session" => SESSION, "csp_meta_tag" => CSP_META_TAG, "csrf_meta_tags" => CSRF_META_TAGS, "csrf_meta_tag" => CSRF_META_TAGS, "date_select" => DATE_SELECT, "datetime_select" => DATETIME_SELECT, "distance_of_time_in_words" => DISTANCE_OF_TIME_IN_WORDS, "relative_time_in_words" => RELATIVE_TIME_IN_WORDS, "select_date" => SELECT_DATE, "select_datetime" => SELECT_DATETIME, "select_day" => SELECT_DAY, "select_hour" => SELECT_HOUR, "select_minute" => SELECT_MINUTE, "select_month" => SELECT_MONTH, "select_second" => SELECT_SECOND, "select_time" => SELECT_TIME, "select_year" => SELECT_YEAR, "time_ago_in_words" => TIME_AGO_IN_WORDS, "distance_of_time_in_words_to_now" => TIME_AGO_IN_WORDS, "time_select" => TIME_SELECT, "time_tag" => TIME_TAG, "debug" => DEBUG, "apply_form_for_options!" => APPLY_FORM_FOR_OPTIONS_BANG, "button" => BUTTON, "checkbox" => CHECKBOX, "check_box" => CHECKBOX, "color_field" => COLOR_FIELD, "date_field" => DATE_FIELD, "datetime_field" => DATETIME_FIELD, "datetime_local_field" => DATETIME_FIELD, "email_field" => EMAIL_FIELD, "emitted_hidden_id?" => EMITTED_HIDDEN_ID_P, "fields" => FIELDS, "fields_for" => FIELDS_FOR, "file_field" => FILE_FIELD, "form_for" => FORM_FOR, "form_with" => FORM_WITH, "form_with_generates_ids" => FORM_WITH_GENERATES_IDS, "form_with_generates_remote_forms" => FORM_WITH_GENERATES_REMOTE_FORMS, "hidden_field" => HIDDEN_FIELD, "label" => LABEL, "month_field" => MONTH_FIELD, "multipart" => MULTIPART, "multiple_file_field_include_hidden" => MULTIPLE_FILE_FIELD_INCLUDE_HIDDEN, "number_field" => NUMBER_FIELD, "password_field" => PASSWORD_FIELD, "radio_button" => RADIO_BUTTON, "range_field" => RANGE_FIELD, "search_field" => SEARCH_FIELD, "submit" => SUBMIT, "telephone_field" => TELEPHONE_FIELD, "phone_field" => TELEPHONE_FIELD, "text_field" => TEXT_FIELD, "textarea" => TEXTAREA, "text_area" => TEXTAREA, "time_field" => TIME_FIELD, "url_field" => URL_FIELD, "week_field" => WEEK_FIELD, "collection_checkboxes" => COLLECTION_CHECKBOXES, "collection_check_boxes" => COLLECTION_CHECKBOXES, "collection_radio_buttons" => COLLECTION_RADIO_BUTTONS, "collection_select" => COLLECTION_SELECT, "grouped_collection_select" => GROUPED_COLLECTION_SELECT, "grouped_options_for_select" => GROUPED_OPTIONS_FOR_SELECT, "option_groups_from_collection_for_select" => OPTION_GROUPS_FROM_COLLECTION_FOR_SELECT, "options_for_select" => OPTIONS_FOR_SELECT, "options_from_collection_for_select" => OPTIONS_FROM_COLLECTION_FOR_SELECT, "select" => SELECT, "time_zone_options_for_select" => TIME_ZONE_OPTIONS_FOR_SELECT, "time_zone_select" => TIME_ZONE_SELECT, "weekday_options_for_select" => WEEKDAY_OPTIONS_FOR_SELECT, "weekday_select" => WEEKDAY_SELECT, "button_tag" => BUTTON_TAG, "checkbox_tag" => CHECKBOX_TAG, "check_box_tag" => CHECKBOX_TAG, "color_field_tag" => COLOR_FIELD_TAG, "date_field_tag" => DATE_FIELD_TAG, "datetime_field_tag" => DATETIME_FIELD_TAG, "datetime_local_field_tag" => DATETIME_FIELD_TAG, "default_enforce_utf8" => DEFAULT_ENFORCE_UTF8, "email_field_tag" => EMAIL_FIELD_TAG, "embed_authenticity_token_in_remote_forms" => EMBED_AUTHENTICITY_TOKEN_IN_REMOTE_FORMS, "field_id" => FIELD_ID, "field_name" => FIELD_NAME, "field_set_tag" => FIELD_SET_TAG, "fieldset_tag" => FIELD_SET_TAG, "file_field_tag" => FILE_FIELD_TAG, "form_tag" => FORM_TAG, "hidden_field_tag" => HIDDEN_FIELD_TAG, "image_submit_tag" => IMAGE_SUBMIT_TAG, "label_tag" => LABEL_TAG, "month_field_tag" => MONTH_FIELD_TAG, "number_field_tag" => NUMBER_FIELD_TAG, "password_field_tag" => PASSWORD_FIELD_TAG, "radio_button_tag" => RADIO_BUTTON_TAG, "range_field_tag" => RANGE_FIELD_TAG, "search_field_tag" => SEARCH_FIELD_TAG, "select_tag" => SELECT_TAG, "submit_tag" => SUBMIT_TAG, "telephone_field_tag" => TELEPHONE_FIELD_TAG, "phone_field_tag" => TELEPHONE_FIELD_TAG, "text_field_tag" => TEXT_FIELD_TAG, "textarea_tag" => TEXTAREA_TAG, "text_area_tag" => TEXTAREA_TAG, "time_field_tag" => TIME_FIELD_TAG, "url_field_tag" => URL_FIELD_TAG, "utf8_enforcer_tag" => UTF8_ENFORCER_TAG, "week_field_tag" => WEEK_FIELD_TAG, "escape_javascript" => ESCAPE_JAVASCRIPT, "j" => ESCAPE_JAVASCRIPT, "javascript_cdata_section" => JAVASCRIPT_CDATA_SECTION, "javascript_tag" => JAVASCRIPT_TAG, "number_to_currency" => NUMBER_TO_CURRENCY, "number_to_human" => NUMBER_TO_HUMAN, "number_to_human_size" => NUMBER_TO_HUMAN_SIZE, "number_to_percentage" => NUMBER_TO_PERCENTAGE, "number_to_phone" => NUMBER_TO_PHONE, "number_with_delimiter" => NUMBER_WITH_DELIMITER, "number_with_precision" => NUMBER_WITH_PRECISION, "raw" => RAW, "safe_join" => SAFE_JOIN, "to_sentence" => TO_SENTENCE, "dom_class" => DOM_CLASS, "dom_id" => DOM_ID, "dom_target" => DOM_TARGET, "model_name_from_record_or_class" => MODEL_NAME_FROM_RECORD_OR_CLASS, "render" => RENDER, "sanitize" => SANITIZE, "sanitize_css" => SANITIZE_CSS, "sanitizer_vendor" => SANITIZER_VENDOR, "strip_links" => STRIP_LINKS, "strip_tags" => STRIP_TAGS, "cdata_section" => CDATA_SECTION, "content_tag" => CONTENT_TAG, "escape_once" => ESCAPE_ONCE, "tag" => TAG, "token_list" => TOKEN_LIST, "class_names" => TOKEN_LIST, "concat" => CONCAT, "current_cycle" => CURRENT_CYCLE, "cycle" => CYCLE, "excerpt" => EXCERPT, "highlight" => HIGHLIGHT, "pluralize" => PLURALIZE, "reset_cycle" => RESET_CYCLE, "safe_concat" => SAFE_CONCAT, "simple_format" => SIMPLE_FORMAT, "truncate" => TRUNCATE, "word_wrap" => WORD_WRAP, "debug_missing_translation" => DEBUG_MISSING_TRANSLATION, "localize" => LOCALIZE, "l" => LOCALIZE, "translate" => TRANSLATE, "t" => TRANSLATE, "button_to" => BUTTON_TO, "button_to_generates_button_tag" => BUTTON_TO_GENERATES_BUTTON_TAG, "current_page?" => CURRENT_PAGE_P, "link_to" => LINK_TO, "link_to_if" => LINK_TO_IF, "link_to_unless" => LINK_TO_UNLESS, "link_to_unless_current" => LINK_TO_UNLESS_CURRENT, "mail_to" => MAIL_TO, "phone_to" => PHONE_TO, "sms_to" => SMS_TO, "url_for" => URL_FOR, "turbo_exempts_page_from_cache" => TURBO_EXEMPTS_PAGE_FROM_CACHE, "turbo_exempts_page_from_cache_tag" => TURBO_EXEMPTS_PAGE_FROM_CACHE_TAG, "turbo_exempts_page_from_preview" => TURBO_EXEMPTS_PAGE_FROM_PREVIEW, "turbo_exempts_page_from_preview_tag" => TURBO_EXEMPTS_PAGE_FROM_PREVIEW_TAG, "turbo_page_requires_reload" => TURBO_PAGE_REQUIRES_RELOAD, "turbo_page_requires_reload_tag" => TURBO_PAGE_REQUIRES_RELOAD_TAG, "turbo_refresh_method_tag" => TURBO_REFRESH_METHOD_TAG, "turbo_refresh_scroll_tag" => TURBO_REFRESH_SCROLL_TAG, "turbo_refreshes_with" => TURBO_REFRESHES_WITH, "turbo_frame_tag" => TURBO_FRAME_TAG, "turbo_include_tags" => TURBO_INCLUDE_TAGS, "turbo_stream_action_tag" => TURBO_STREAM_ACTION_TAG, "turbo_stream_refresh_tag" => TURBO_STREAM_REFRESH_TAG, "turbo_stream" => TURBO_STREAM, "turbo_stream_from" => TURBO_STREAM_FROM, }.freeze
- BY_SOURCE =
: Hash[String, HelperEntry]
{ "ActionCable::Helpers::ActionCableHelper#action_cable_meta_tag" => ACTION_CABLE_META_TAG, "ActionController::ContentSecurityPolicy#content_security_policy?" => CONTENT_SECURITY_POLICY_P, "ActionController::ContentSecurityPolicy#content_security_policy_nonce" => CONTENT_SECURITY_POLICY_NONCE, "ActionDispatch::Routing::PolymorphicRoutes#polymorphic_path" => POLYMORPHIC_PATH, "ActionDispatch::Routing::PolymorphicRoutes#polymorphic_url" => POLYMORPHIC_URL, "ActionController::RequestForgeryProtection#form_authenticity_token" => FORM_AUTHENTICITY_TOKEN, "ActionController::RequestForgeryProtection#protect_against_forgery?" => PROTECT_AGAINST_FORGERY_P, "ActionText::ContentHelper#render_action_text_content" => RENDER_ACTION_TEXT_CONTENT, "ActionText::ContentHelper#sanitize_action_text_content" => SANITIZE_ACTION_TEXT_CONTENT, "ActionText::TagHelper#rich_textarea_tag" => RICH_TEXTAREA_TAG, "ActionView::Helpers::ActiveModelHelper#error_message" => ERROR_MESSAGE, "ActionView::Helpers::ActiveModelHelper#error_wrapping" => ERROR_WRAPPING, "ActionView::Helpers::ActiveModelHelper#object" => OBJECT, "ActionView::Helpers::AssetTagHelper#apply_stylesheet_media_default" => APPLY_STYLESHEET_MEDIA_DEFAULT, "ActionView::Helpers::AssetTagHelper#audio_tag" => AUDIO_TAG, "ActionView::Helpers::AssetTagHelper#auto_discovery_link_tag" => AUTO_DISCOVERY_LINK_TAG, "ActionView::Helpers::AssetTagHelper#auto_include_nonce" => AUTO_INCLUDE_NONCE, "ActionView::Helpers::AssetTagHelper#auto_include_nonce_for_scripts" => AUTO_INCLUDE_NONCE_FOR_SCRIPTS, "ActionView::Helpers::AssetTagHelper#auto_include_nonce_for_styles" => AUTO_INCLUDE_NONCE_FOR_STYLES, "ActionView::Helpers::AssetTagHelper#favicon_link_tag" => FAVICON_LINK_TAG, "ActionView::Helpers::AssetTagHelper#image_decoding" => IMAGE_DECODING, "ActionView::Helpers::AssetTagHelper#image_loading" => IMAGE_LOADING, "ActionView::Helpers::AssetTagHelper#image_tag" => IMAGE_TAG, "ActionView::Helpers::AssetTagHelper#javascript_include_tag" => JAVASCRIPT_INCLUDE_TAG, "ActionView::Helpers::AssetTagHelper#picture_tag" => PICTURE_TAG, "ActionView::Helpers::AssetTagHelper#preload_link_tag" => PRELOAD_LINK_TAG, "ActionView::Helpers::AssetTagHelper#preload_links_header" => PRELOAD_LINKS_HEADER, "ActionView::Helpers::AssetTagHelper#stylesheet_link_tag" => STYLESHEET_LINK_TAG, "ActionView::Helpers::AssetTagHelper#video_tag" => VIDEO_TAG, "ActionView::Helpers::AssetUrlHelper#asset_path" => ASSET_PATH, "ActionView::Helpers::AssetUrlHelper#asset_url" => ASSET_URL, "ActionView::Helpers::AssetUrlHelper#audio_path" => AUDIO_PATH, "ActionView::Helpers::AssetUrlHelper#audio_url" => AUDIO_URL, "ActionView::Helpers::AssetUrlHelper#compute_asset_extname" => COMPUTE_ASSET_EXTNAME, "ActionView::Helpers::AssetUrlHelper#compute_asset_host" => COMPUTE_ASSET_HOST, "ActionView::Helpers::AssetUrlHelper#compute_asset_path" => COMPUTE_ASSET_PATH, "ActionView::Helpers::AssetUrlHelper#font_path" => FONT_PATH, "ActionView::Helpers::AssetUrlHelper#font_url" => FONT_URL, "ActionView::Helpers::AssetUrlHelper#image_path" => IMAGE_PATH, "ActionView::Helpers::AssetUrlHelper#image_url" => IMAGE_URL, "ActionView::Helpers::AssetUrlHelper#javascript_path" => JAVASCRIPT_PATH, "ActionView::Helpers::AssetUrlHelper#javascript_url" => JAVASCRIPT_URL, "ActionView::Helpers::AssetUrlHelper#public_compute_asset_path" => PUBLIC_COMPUTE_ASSET_PATH, "ActionView::Helpers::AssetUrlHelper#stylesheet_path" => STYLESHEET_PATH, "ActionView::Helpers::AssetUrlHelper#stylesheet_url" => STYLESHEET_URL, "ActionView::Helpers::AssetUrlHelper#video_path" => VIDEO_PATH, "ActionView::Helpers::AssetUrlHelper#video_url" => VIDEO_URL, "ActionView::Helpers::AtomFeedHelper#atom_feed" => ATOM_FEED, "ActionView::Helpers::CacheHelper#cache" => CACHE, "ActionView::Helpers::CacheHelper#cache_fragment_name" => CACHE_FRAGMENT_NAME, "ActionView::Helpers::CacheHelper#cache_if" => CACHE_IF, "ActionView::Helpers::CacheHelper#cache_unless" => CACHE_UNLESS, "ActionView::Helpers::CacheHelper#caching?" => CACHING_P, "ActionView::Helpers::CacheHelper#digest_path_from_template" => DIGEST_PATH_FROM_TEMPLATE, "ActionView::Helpers::CacheHelper#fragment_for" => FRAGMENT_FOR, "ActionView::Helpers::CacheHelper#fragment_name_with_digest" => FRAGMENT_NAME_WITH_DIGEST, "ActionView::Helpers::CacheHelper#read_fragment_for" => READ_FRAGMENT_FOR, "ActionView::Helpers::CacheHelper#uncacheable!" => UNCACHEABLE_BANG, "ActionView::Helpers::CacheHelper#write_fragment_for" => WRITE_FRAGMENT_FOR, "ActionView::Helpers::CaptureHelper#capture" => CAPTURE, "ActionView::Helpers::CaptureHelper#content_for" => CONTENT_FOR, "ActionView::Helpers::CaptureHelper#content_for?" => CONTENT_FOR_P, "ActionView::Helpers::CaptureHelper#provide" => PROVIDE, "ActionView::Helpers::CaptureHelper#with_output_buffer" => WITH_OUTPUT_BUFFER, "ActionView::Helpers::ContentExfiltrationPreventionHelper#prepend_content_exfiltration_prevention" => PREPEND_CONTENT_EXFILTRATION_PREVENTION, "ActionView::Helpers::ContentExfiltrationPreventionHelper#prevent_content_exfiltration" => PREVENT_CONTENT_EXFILTRATION, "ActionView::Helpers::ControllerHelper#action_name" => ACTION_NAME, "ActionView::Helpers::ControllerHelper#assign_controller" => ASSIGN_CONTROLLER, "ActionView::Helpers::ControllerHelper#controller" => CONTROLLER, "ActionView::Helpers::ControllerHelper#controller_name" => CONTROLLER_NAME, "ActionView::Helpers::ControllerHelper#controller_path" => CONTROLLER_PATH, "ActionView::Helpers::ControllerHelper#cookies" => COOKIES, "ActionView::Helpers::ControllerHelper#flash" => FLASH, "ActionView::Helpers::ControllerHelper#headers" => HEADERS, "ActionView::Helpers::ControllerHelper#logger" => LOGGER, "ActionView::Helpers::ControllerHelper#params" => PARAMS, "ActionView::Helpers::ControllerHelper#request" => REQUEST, "ActionView::Helpers::ControllerHelper#request_forgery_protection_token" => REQUEST_FORGERY_PROTECTION_TOKEN, "ActionView::Helpers::ControllerHelper#response" => RESPONSE, "ActionView::Helpers::ControllerHelper#session" => SESSION, "ActionView::Helpers::CspHelper#csp_meta_tag" => CSP_META_TAG, "ActionView::Helpers::CsrfHelper#csrf_meta_tags" => CSRF_META_TAGS, "ActionView::Helpers::DateHelper#date_select" => DATE_SELECT, "ActionView::Helpers::DateHelper#datetime_select" => DATETIME_SELECT, "ActionView::Helpers::DateHelper#distance_of_time_in_words" => DISTANCE_OF_TIME_IN_WORDS, "ActionView::Helpers::DateHelper#relative_time_in_words" => RELATIVE_TIME_IN_WORDS, "ActionView::Helpers::DateHelper#select_date" => SELECT_DATE, "ActionView::Helpers::DateHelper#select_datetime" => SELECT_DATETIME, "ActionView::Helpers::DateHelper#select_day" => SELECT_DAY, "ActionView::Helpers::DateHelper#select_hour" => SELECT_HOUR, "ActionView::Helpers::DateHelper#select_minute" => SELECT_MINUTE, "ActionView::Helpers::DateHelper#select_month" => SELECT_MONTH, "ActionView::Helpers::DateHelper#select_second" => SELECT_SECOND, "ActionView::Helpers::DateHelper#select_time" => SELECT_TIME, "ActionView::Helpers::DateHelper#select_year" => SELECT_YEAR, "ActionView::Helpers::DateHelper#time_ago_in_words" => TIME_AGO_IN_WORDS, "ActionView::Helpers::DateHelper#time_select" => TIME_SELECT, "ActionView::Helpers::DateHelper#time_tag" => TIME_TAG, "ActionView::Helpers::DebugHelper#debug" => DEBUG, "ActionView::Helpers::FormHelper#apply_form_for_options!" => APPLY_FORM_FOR_OPTIONS_BANG, "ActionView::Helpers::FormHelper#button" => BUTTON, "ActionView::Helpers::FormHelper#checkbox" => CHECKBOX, "ActionView::Helpers::FormHelper#color_field" => COLOR_FIELD, "ActionView::Helpers::FormHelper#date_field" => DATE_FIELD, "ActionView::Helpers::FormHelper#datetime_field" => DATETIME_FIELD, "ActionView::Helpers::FormHelper#email_field" => EMAIL_FIELD, "ActionView::Helpers::FormHelper#emitted_hidden_id?" => EMITTED_HIDDEN_ID_P, "ActionView::Helpers::FormHelper#fields" => FIELDS, "ActionView::Helpers::FormHelper#fields_for" => FIELDS_FOR, "ActionView::Helpers::FormHelper#file_field" => FILE_FIELD, "ActionView::Helpers::FormHelper#form_for" => FORM_FOR, "ActionView::Helpers::FormHelper#form_with" => FORM_WITH, "ActionView::Helpers::FormHelper#form_with_generates_ids" => FORM_WITH_GENERATES_IDS, "ActionView::Helpers::FormHelper#form_with_generates_remote_forms" => FORM_WITH_GENERATES_REMOTE_FORMS, "ActionView::Helpers::FormHelper#hidden_field" => HIDDEN_FIELD, "ActionView::Helpers::FormHelper#label" => LABEL, "ActionView::Helpers::FormHelper#month_field" => MONTH_FIELD, "ActionView::Helpers::FormHelper#multipart" => MULTIPART, "ActionView::Helpers::FormHelper#multiple_file_field_include_hidden" => MULTIPLE_FILE_FIELD_INCLUDE_HIDDEN, "ActionView::Helpers::FormHelper#number_field" => NUMBER_FIELD, "ActionView::Helpers::FormHelper#password_field" => PASSWORD_FIELD, "ActionView::Helpers::FormHelper#radio_button" => RADIO_BUTTON, "ActionView::Helpers::FormHelper#range_field" => RANGE_FIELD, "ActionView::Helpers::FormHelper#search_field" => SEARCH_FIELD, "ActionView::Helpers::FormHelper#submit" => SUBMIT, "ActionView::Helpers::FormHelper#telephone_field" => TELEPHONE_FIELD, "ActionView::Helpers::FormHelper#text_field" => TEXT_FIELD, "ActionView::Helpers::FormHelper#textarea" => TEXTAREA, "ActionView::Helpers::FormHelper#time_field" => TIME_FIELD, "ActionView::Helpers::FormHelper#url_field" => URL_FIELD, "ActionView::Helpers::FormHelper#week_field" => WEEK_FIELD, "ActionView::Helpers::FormOptionsHelper#collection_checkboxes" => COLLECTION_CHECKBOXES, "ActionView::Helpers::FormOptionsHelper#collection_radio_buttons" => COLLECTION_RADIO_BUTTONS, "ActionView::Helpers::FormOptionsHelper#collection_select" => COLLECTION_SELECT, "ActionView::Helpers::FormOptionsHelper#grouped_collection_select" => GROUPED_COLLECTION_SELECT, "ActionView::Helpers::FormOptionsHelper#grouped_options_for_select" => GROUPED_OPTIONS_FOR_SELECT, "ActionView::Helpers::FormOptionsHelper#option_groups_from_collection_for_select" => OPTION_GROUPS_FROM_COLLECTION_FOR_SELECT, "ActionView::Helpers::FormOptionsHelper#options_for_select" => OPTIONS_FOR_SELECT, "ActionView::Helpers::FormOptionsHelper#options_from_collection_for_select" => OPTIONS_FROM_COLLECTION_FOR_SELECT, "ActionView::Helpers::FormOptionsHelper#select" => SELECT, "ActionView::Helpers::FormOptionsHelper#time_zone_options_for_select" => TIME_ZONE_OPTIONS_FOR_SELECT, "ActionView::Helpers::FormOptionsHelper#time_zone_select" => TIME_ZONE_SELECT, "ActionView::Helpers::FormOptionsHelper#weekday_options_for_select" => WEEKDAY_OPTIONS_FOR_SELECT, "ActionView::Helpers::FormOptionsHelper#weekday_select" => WEEKDAY_SELECT, "ActionView::Helpers::FormTagHelper#button_tag" => BUTTON_TAG, "ActionView::Helpers::FormTagHelper#checkbox_tag" => CHECKBOX_TAG, "ActionView::Helpers::FormTagHelper#color_field_tag" => COLOR_FIELD_TAG, "ActionView::Helpers::FormTagHelper#date_field_tag" => DATE_FIELD_TAG, "ActionView::Helpers::FormTagHelper#datetime_field_tag" => DATETIME_FIELD_TAG, "ActionView::Helpers::FormTagHelper#default_enforce_utf8" => DEFAULT_ENFORCE_UTF8, "ActionView::Helpers::FormTagHelper#email_field_tag" => EMAIL_FIELD_TAG, "ActionView::Helpers::FormTagHelper#embed_authenticity_token_in_remote_forms" => EMBED_AUTHENTICITY_TOKEN_IN_REMOTE_FORMS, "ActionView::Helpers::FormTagHelper#field_id" => FIELD_ID, "ActionView::Helpers::FormTagHelper#field_name" => FIELD_NAME, "ActionView::Helpers::FormTagHelper#field_set_tag" => FIELD_SET_TAG, "ActionView::Helpers::FormTagHelper#file_field_tag" => FILE_FIELD_TAG, "ActionView::Helpers::FormTagHelper#form_tag" => FORM_TAG, "ActionView::Helpers::FormTagHelper#hidden_field_tag" => HIDDEN_FIELD_TAG, "ActionView::Helpers::FormTagHelper#image_submit_tag" => IMAGE_SUBMIT_TAG, "ActionView::Helpers::FormTagHelper#label_tag" => LABEL_TAG, "ActionView::Helpers::FormTagHelper#month_field_tag" => MONTH_FIELD_TAG, "ActionView::Helpers::FormTagHelper#number_field_tag" => NUMBER_FIELD_TAG, "ActionView::Helpers::FormTagHelper#password_field_tag" => PASSWORD_FIELD_TAG, "ActionView::Helpers::FormTagHelper#radio_button_tag" => RADIO_BUTTON_TAG, "ActionView::Helpers::FormTagHelper#range_field_tag" => RANGE_FIELD_TAG, "ActionView::Helpers::FormTagHelper#search_field_tag" => SEARCH_FIELD_TAG, "ActionView::Helpers::FormTagHelper#select_tag" => SELECT_TAG, "ActionView::Helpers::FormTagHelper#submit_tag" => SUBMIT_TAG, "ActionView::Helpers::FormTagHelper#telephone_field_tag" => TELEPHONE_FIELD_TAG, "ActionView::Helpers::FormTagHelper#text_field_tag" => TEXT_FIELD_TAG, "ActionView::Helpers::FormTagHelper#textarea_tag" => TEXTAREA_TAG, "ActionView::Helpers::FormTagHelper#time_field_tag" => TIME_FIELD_TAG, "ActionView::Helpers::FormTagHelper#url_field_tag" => URL_FIELD_TAG, "ActionView::Helpers::FormTagHelper#utf8_enforcer_tag" => UTF8_ENFORCER_TAG, "ActionView::Helpers::FormTagHelper#week_field_tag" => WEEK_FIELD_TAG, "ActionView::Helpers::JavaScriptHelper#escape_javascript" => ESCAPE_JAVASCRIPT, "ActionView::Helpers::JavaScriptHelper#javascript_cdata_section" => JAVASCRIPT_CDATA_SECTION, "ActionView::Helpers::JavaScriptHelper#javascript_tag" => JAVASCRIPT_TAG, "ActionView::Helpers::NumberHelper#number_to_currency" => NUMBER_TO_CURRENCY, "ActionView::Helpers::NumberHelper#number_to_human" => NUMBER_TO_HUMAN, "ActionView::Helpers::NumberHelper#number_to_human_size" => NUMBER_TO_HUMAN_SIZE, "ActionView::Helpers::NumberHelper#number_to_percentage" => NUMBER_TO_PERCENTAGE, "ActionView::Helpers::NumberHelper#number_to_phone" => NUMBER_TO_PHONE, "ActionView::Helpers::NumberHelper#number_with_delimiter" => NUMBER_WITH_DELIMITER, "ActionView::Helpers::NumberHelper#number_with_precision" => NUMBER_WITH_PRECISION, "ActionView::Helpers::OutputSafetyHelper#raw" => RAW, "ActionView::Helpers::OutputSafetyHelper#safe_join" => SAFE_JOIN, "ActionView::Helpers::OutputSafetyHelper#to_sentence" => TO_SENTENCE, "ActionView::RecordIdentifier#dom_class" => DOM_CLASS, "ActionView::RecordIdentifier#dom_id" => DOM_ID, "ActionView::RecordIdentifier#dom_target" => DOM_TARGET, "ActionView::RecordIdentifier#model_name_from_record_or_class" => MODEL_NAME_FROM_RECORD_OR_CLASS, "ActionView::Helpers::RenderingHelper#render" => RENDER, "ActionView::Helpers::SanitizeHelper#sanitize" => SANITIZE, "ActionView::Helpers::SanitizeHelper#sanitize_css" => SANITIZE_CSS, "ActionView::Helpers::SanitizeHelper#sanitizer_vendor" => SANITIZER_VENDOR, "ActionView::Helpers::SanitizeHelper#strip_links" => STRIP_LINKS, "ActionView::Helpers::SanitizeHelper#strip_tags" => STRIP_TAGS, "ActionView::Helpers::TagHelper#cdata_section" => CDATA_SECTION, "ActionView::Helpers::TagHelper#content_tag" => CONTENT_TAG, "ActionView::Helpers::TagHelper#escape_once" => ESCAPE_ONCE, "ActionView::Helpers::TagHelper#tag" => TAG, "ActionView::Helpers::TagHelper#token_list" => TOKEN_LIST, "ActionView::Helpers::TextHelper#concat" => CONCAT, "ActionView::Helpers::TextHelper#current_cycle" => CURRENT_CYCLE, "ActionView::Helpers::TextHelper#cycle" => CYCLE, "ActionView::Helpers::TextHelper#excerpt" => EXCERPT, "ActionView::Helpers::TextHelper#highlight" => HIGHLIGHT, "ActionView::Helpers::TextHelper#pluralize" => PLURALIZE, "ActionView::Helpers::TextHelper#reset_cycle" => RESET_CYCLE, "ActionView::Helpers::TextHelper#safe_concat" => SAFE_CONCAT, "ActionView::Helpers::TextHelper#simple_format" => SIMPLE_FORMAT, "ActionView::Helpers::TextHelper#truncate" => TRUNCATE, "ActionView::Helpers::TextHelper#word_wrap" => WORD_WRAP, "ActionView::Helpers::TranslationHelper#debug_missing_translation" => DEBUG_MISSING_TRANSLATION, "ActionView::Helpers::TranslationHelper#localize" => LOCALIZE, "ActionView::Helpers::TranslationHelper#translate" => TRANSLATE, "ActionView::Helpers::UrlHelper#button_to" => BUTTON_TO, "ActionView::Helpers::UrlHelper#button_to_generates_button_tag" => BUTTON_TO_GENERATES_BUTTON_TAG, "ActionView::Helpers::UrlHelper#current_page?" => CURRENT_PAGE_P, "ActionView::Helpers::UrlHelper#link_to" => LINK_TO, "ActionView::Helpers::UrlHelper#link_to_if" => LINK_TO_IF, "ActionView::Helpers::UrlHelper#link_to_unless" => LINK_TO_UNLESS, "ActionView::Helpers::UrlHelper#link_to_unless_current" => LINK_TO_UNLESS_CURRENT, "ActionView::Helpers::UrlHelper#mail_to" => MAIL_TO, "ActionView::Helpers::UrlHelper#phone_to" => PHONE_TO, "ActionView::Helpers::UrlHelper#sms_to" => SMS_TO, "ActionView::Helpers::UrlHelper#url_for" => URL_FOR, "Turbo::DriveHelper#turbo_exempts_page_from_cache" => TURBO_EXEMPTS_PAGE_FROM_CACHE, "Turbo::DriveHelper#turbo_exempts_page_from_cache_tag" => TURBO_EXEMPTS_PAGE_FROM_CACHE_TAG, "Turbo::DriveHelper#turbo_exempts_page_from_preview" => TURBO_EXEMPTS_PAGE_FROM_PREVIEW, "Turbo::DriveHelper#turbo_exempts_page_from_preview_tag" => TURBO_EXEMPTS_PAGE_FROM_PREVIEW_TAG, "Turbo::DriveHelper#turbo_page_requires_reload" => TURBO_PAGE_REQUIRES_RELOAD, "Turbo::DriveHelper#turbo_page_requires_reload_tag" => TURBO_PAGE_REQUIRES_RELOAD_TAG, "Turbo::DriveHelper#turbo_refresh_method_tag" => TURBO_REFRESH_METHOD_TAG, "Turbo::DriveHelper#turbo_refresh_scroll_tag" => TURBO_REFRESH_SCROLL_TAG, "Turbo::DriveHelper#turbo_refreshes_with" => TURBO_REFRESHES_WITH, "Turbo::FramesHelper#turbo_frame_tag" => TURBO_FRAME_TAG, "Turbo::IncludesHelper#turbo_include_tags" => TURBO_INCLUDE_TAGS, "Turbo::Streams::ActionHelper#turbo_stream_action_tag" => TURBO_STREAM_ACTION_TAG, "Turbo::Streams::ActionHelper#turbo_stream_refresh_tag" => TURBO_STREAM_REFRESH_TAG, "Turbo::StreamsHelper#turbo_stream" => TURBO_STREAM, "Turbo::StreamsHelper#turbo_stream_from" => TURBO_STREAM_FROM, }.freeze
- BY_TAG_NAME =
{ "meta" => [ACTION_CABLE_META_TAG, CSP_META_TAG, CSRF_META_TAGS, TURBO_EXEMPTS_PAGE_FROM_CACHE_TAG, TURBO_EXEMPTS_PAGE_FROM_PREVIEW_TAG, TURBO_PAGE_REQUIRES_RELOAD_TAG, TURBO_REFRESH_METHOD_TAG, TURBO_REFRESH_SCROLL_TAG].freeze, "trix-editor" => [RICH_TEXTAREA_TAG].freeze, "audio" => [AUDIO_TAG].freeze, "link" => [AUTO_DISCOVERY_LINK_TAG, FAVICON_LINK_TAG, PRELOAD_LINK_TAG, STYLESHEET_LINK_TAG].freeze, "img" => [IMAGE_TAG].freeze, "script" => [JAVASCRIPT_INCLUDE_TAG, JAVASCRIPT_TAG].freeze, "picture" => [PICTURE_TAG].freeze, "video" => [VIDEO_TAG].freeze, "time" => [TIME_TAG].freeze, "form" => [FORM_FOR, FORM_WITH, FORM_TAG, BUTTON_TO].freeze, "button" => [BUTTON_TAG].freeze, "input" => [CHECKBOX_TAG, COLOR_FIELD_TAG, DATE_FIELD_TAG, DATETIME_FIELD_TAG, EMAIL_FIELD_TAG, FILE_FIELD_TAG, HIDDEN_FIELD_TAG, IMAGE_SUBMIT_TAG, MONTH_FIELD_TAG, NUMBER_FIELD_TAG, PASSWORD_FIELD_TAG, RADIO_BUTTON_TAG, RANGE_FIELD_TAG, SEARCH_FIELD_TAG, SUBMIT_TAG, TELEPHONE_FIELD_TAG, TEXT_FIELD_TAG, TIME_FIELD_TAG, URL_FIELD_TAG, WEEK_FIELD_TAG].freeze, "fieldset" => [FIELD_SET_TAG].freeze, "label" => [LABEL_TAG].freeze, "select" => [SELECT_TAG].freeze, "textarea" => [TEXTAREA_TAG].freeze, "a" => [LINK_TO, LINK_TO_IF, LINK_TO_UNLESS, LINK_TO_UNLESS_CURRENT, MAIL_TO, PHONE_TO, SMS_TO].freeze, "turbo-frame" => [TURBO_FRAME_TAG].freeze, "turbo-stream" => [TURBO_STREAM_ACTION_TAG, TURBO_STREAM_REFRESH_TAG].freeze, "turbo-cable-stream-source" => [TURBO_STREAM_FROM].freeze, }.freeze
Class Method Summary collapse
-
.by_gem(gem_name) ⇒ Object
: (String) -> Array.
-
.by_module(module_name) ⇒ Object
: (String) -> Array.
-
.by_output(output) ⇒ Object
: (Symbol) -> Array.
-
.count ⇒ Object
: () -> Integer.
-
.each(&block) ⇒ Object
: () { (HelperEntry) -> void } -> void.
-
.entries ⇒ Object
: () -> Array.
-
.exists?(name) ⇒ Boolean
: (String) -> bool.
-
.find_by_source(source) ⇒ Object
: (String) -> HelperEntry?.
-
.find_preferred_for_tag(tag_name) ⇒ Object
: (String) -> HelperEntry?.
-
.get(name) ⇒ Object
: (String) -> HelperEntry?.
-
.helpers_for_tag(tag_name) ⇒ Object
: (String) -> Array.
-
.supported ⇒ Object
: () -> Array.
-
.supported?(name) ⇒ Boolean
: (String) -> bool.
Class Method Details
.by_gem(gem_name) ⇒ Object
: (String) -> Array
8091 8092 8093 |
# File 'lib/herb/action_view/helper_registry.rb', line 8091 def by_gem(gem_name) entries.select { |entry| entry.gem == gem_name } end |
.by_module(module_name) ⇒ Object
: (String) -> Array
8101 8102 8103 |
# File 'lib/herb/action_view/helper_registry.rb', line 8101 def by_module(module_name) entries.select { |entry| entry.source.split("#").first.split("::").last == module_name } end |
.by_output(output) ⇒ Object
: (Symbol) -> Array
8096 8097 8098 |
# File 'lib/herb/action_view/helper_registry.rb', line 8096 def by_output(output) entries.select { |entry| entry.output == output } end |
.count ⇒ Object
: () -> Integer
8070 8071 8072 |
# File 'lib/herb/action_view/helper_registry.rb', line 8070 def count ENTRIES.size end |
.each(&block) ⇒ Object
: () { (HelperEntry) -> void } -> void
8052 8053 8054 |
# File 'lib/herb/action_view/helper_registry.rb', line 8052 def each(&block) entries.each(&block) end |
.entries ⇒ Object
: () -> Array
8047 8048 8049 |
# File 'lib/herb/action_view/helper_registry.rb', line 8047 def entries ENTRIES.values end |
.exists?(name) ⇒ Boolean
: (String) -> bool
8081 8082 8083 |
# File 'lib/herb/action_view/helper_registry.rb', line 8081 def exists?(name) ENTRIES.key?(name.to_s) end |
.find_by_source(source) ⇒ Object
: (String) -> HelperEntry?
8042 8043 8044 |
# File 'lib/herb/action_view/helper_registry.rb', line 8042 def find_by_source(source) BY_SOURCE[source] end |
.find_preferred_for_tag(tag_name) ⇒ Object
: (String) -> HelperEntry?
8062 8063 8064 8065 8066 8067 |
# File 'lib/herb/action_view/helper_registry.rb', line 8062 def find_preferred_for_tag(tag_name) helpers = BY_TAG_NAME[tag_name] return nil unless helpers helpers.find(&:preferred_for_tag?) || helpers.first end |
.get(name) ⇒ Object
: (String) -> HelperEntry?
8037 8038 8039 |
# File 'lib/herb/action_view/helper_registry.rb', line 8037 def get(name) ENTRIES[name.to_s] end |
.helpers_for_tag(tag_name) ⇒ Object
: (String) -> Array
8057 8058 8059 |
# File 'lib/herb/action_view/helper_registry.rb', line 8057 def helpers_for_tag(tag_name) BY_TAG_NAME[tag_name] || [] end |
.supported ⇒ Object
: () -> Array
8086 8087 8088 |
# File 'lib/herb/action_view/helper_registry.rb', line 8086 def supported entries.select(&:supported?) end |
.supported?(name) ⇒ Boolean
: (String) -> bool
8075 8076 8077 8078 |
# File 'lib/herb/action_view/helper_registry.rb', line 8075 def supported?(name) entry = get(name) entry&.supported? || false end |