aboutsummaryrefslogtreecommitdiff
path: root/src/components/shared/field.cr
diff options
context:
space:
mode:
Diffstat (limited to 'src/components/shared/field.cr')
-rw-r--r--src/components/shared/field.cr57
1 files changed, 57 insertions, 0 deletions
diff --git a/src/components/shared/field.cr b/src/components/shared/field.cr
new file mode 100644
index 0000000..5c32e8a
--- /dev/null
+++ b/src/components/shared/field.cr
@@ -0,0 +1,57 @@
+# This component is used to make it easier to render the same fields styles
+# throughout your app.
+#
+# Extensive documentation at: https://luckyframework.org/guides/frontend/html-forms#shared-components
+#
+# ## Basic usage:
+#
+# # Renders a text input by default and will guess the label name "Name"
+# mount Shared::Field, op.name
+# # Call any of the input methods on the block
+# mount Shared::Field, op.email, &.email_input
+# # Add other HTML attributes
+# mount Shared::Field, op.email, &.email_input(autofocus: "true")
+# # Pass an explicit label name
+# mount Shared::Field, attribute: op.username, label_text: "Your username"
+#
+# ## Customization
+#
+# You can customize this component so that fields render like you expect.
+# For example, you might wrap it in a div with a "field-wrapper" class.
+#
+# div class: "field-wrapper"
+# label_for field
+# yield field
+# mount Shared::FieldErrors, field
+# end
+#
+# You may also want to have more components if your fields look
+# different in different parts of your app, e.g. `CompactField` or
+# `InlineTextField`
+class Shared::Field(T) < BaseComponent
+ # Raises a helpful error if component receives an unpermitted attribute
+ include Lucky::CatchUnpermittedAttribute
+
+ needs attribute : Avram::PermittedAttribute(T)
+ needs label_text : String?
+
+ def render(&)
+ label_for attribute, label_text
+
+ # You can add more default options here. For example:
+ #
+ # tag_defaults field: attribute, class: "input"
+ #
+ # Will add the class "input" to the generated HTML.
+ tag_defaults field: attribute do |tag_builder|
+ yield tag_builder
+ end
+
+ mount Shared::FieldErrors, attribute
+ end
+
+ # Use a text_input by default
+ def render
+ render &.text_input
+ end
+end