From d3293c6a7061beb8dbfe6c56fe3c169f4aad8c1e Mon Sep 17 00:00:00 2001 From: Bogdan Gusiev Date: Thu, 14 Nov 2024 09:52:39 +0100 Subject: [PATCH] Datagrid filter input helper doc --- lib/datagrid/form_builder.rb | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/datagrid/form_builder.rb b/lib/datagrid/form_builder.rb index 3138db22..ed87506b 100644 --- a/lib/datagrid/form_builder.rb +++ b/lib/datagrid/form_builder.rb @@ -25,7 +25,11 @@ def datagrid_label(filter_or_attribute, text = nil, **options, &block) label(filter.name, text || filter.header, **filter.label_options, **options, &block) end - # @visibility private + # @param filter_or_attribute [Datagrid::Filters::BaseFilter, String, Symbol] filter object or filter name + # @param options [{Symbol => Object}] HTML attributes to assign to input tag + # * `type` - special attribute the determines an input tag to be made. + # Examples: `text`, `select`, `textarea`, `number`, `date` etc. + # @return [String] an input tag for the corresponding filter name def datagrid_filter_input(attribute_or_filter, **options) filter = datagrid_get_filter(attribute_or_filter) value = object.filter_value_as_string(filter)