From cec691256e4fa07d78f9b583704f157e9499a8f8 Mon Sep 17 00:00:00 2001 From: Samuel P Date: Fri, 3 Feb 2023 17:17:41 -0500 Subject: [PATCH 1/6] docs: added "Customizing options" section --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b50c9cb..a299c86 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ import ( ``` -#### Customizing +### Customizing Customizing the form helpers is done by passing different instances of `tailush.Option` to the `FormFn` and `FormForFn` functions. The following example shows a set of options that can be passed to the helpers. @@ -45,4 +45,20 @@ Customizing the form helpers is done by passing different instances of `tailush. ... ``` +#### Customizing options + +The following options are available for the form helpers: + +| Option ⚙️ | Component ⚒️ | Preview 🔎 | +|------------------------------------|-----------------------------|------------| +| `tailush.UseLabelClass()` | `<%= f.Label() %>` | | +| `tailush.UseInputClass()` | `<%= f.InputTag() %>` | | +| `tailush.UseCheckboxClass()` | `<%= f.CheckboxTag() %>` | | +| `tailush.UseRadioClass()` | `<%= f.RadioButtonTag() %>` | | +| `tailush.UseFileClass()` | `<%= f.FileTag() %>` | | +| `tailush.UseTextAreaClass()` | `<%= f.TextAreaTag() %>` | | +| `tailush.UseSelectClass()` | `<%= f.SelectTag() %>` | | +| `tailush.UseDateInputClass()` | `<%= f.DateTimeTag() %>` | | +| `tailush.UseFieldContainerClass()` | Not implemented yet | | +| `tailush.UseErrorClass()` | Not implemented yet | | From 411e57206c255f486ca30c5243082e5f81068cea Mon Sep 17 00:00:00 2001 From: Samuel P Date: Mon, 6 Feb 2023 08:20:35 -0500 Subject: [PATCH 2/6] docs: added "Used classes" column --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a299c86..3eeee0f 100644 --- a/README.md +++ b/README.md @@ -49,16 +49,17 @@ Customizing the form helpers is done by passing different instances of `tailush. The following options are available for the form helpers: -| Option ⚙️ | Component ⚒️ | Preview 🔎 | -|------------------------------------|-----------------------------|------------| -| `tailush.UseLabelClass()` | `<%= f.Label() %>` | | -| `tailush.UseInputClass()` | `<%= f.InputTag() %>` | | -| `tailush.UseCheckboxClass()` | `<%= f.CheckboxTag() %>` | | -| `tailush.UseRadioClass()` | `<%= f.RadioButtonTag() %>` | | -| `tailush.UseFileClass()` | `<%= f.FileTag() %>` | | -| `tailush.UseTextAreaClass()` | `<%= f.TextAreaTag() %>` | | -| `tailush.UseSelectClass()` | `<%= f.SelectTag() %>` | | -| `tailush.UseDateInputClass()` | `<%= f.DateTimeTag() %>` | | -| `tailush.UseFieldContainerClass()` | Not implemented yet | | -| `tailush.UseErrorClass()` | Not implemented yet | | +| Option ⚙️ | Component ⚒️ | Used Classes | +|------------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| `tailush.UseLabelClass()` | `<%= f.Label() %>` | block text-sm font-medium text-gray-700 | +| `tailush.UseInputClass()` | `<%= f.InputTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | +| `tailush.UseCheckboxClass()` | `<%= f.CheckboxTag() %>` | TBD | +| `tailush.UseRadioClass()` | `<%= f.RadioButtonTag() %>` | TBD | +| `tailush.UseFileClass()` | `<%= f.FileTag() %>` | TBD | +| `tailush.UseTextAreaClass()` | `<%= f.TextAreaTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full | +| `tailush.UseSelectClass()` | `<%= f.SelectTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full py-2 mt-1 text-base sm:text-sm | +| `tailush.UseDateInputClass()` | `<%= f.DateTimeTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | +| `tailush.UseFieldContainerClass()` | Not implemented yet | TBD | +| `tailush.UseErrorClass()` | Not implemented yet | TBD | + From b4be9cba160de713f02bba8cd267e95a2155cb92 Mon Sep 17 00:00:00 2001 From: Samuel P Date: Mon, 6 Feb 2023 08:42:15 -0500 Subject: [PATCH 3/6] docs: added fixed width to avoid linebreaking --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3eeee0f..3c8a192 100644 --- a/README.md +++ b/README.md @@ -49,17 +49,17 @@ Customizing the form helpers is done by passing different instances of `tailush. The following options are available for the form helpers: -| Option ⚙️ | Component ⚒️ | Used Classes | -|------------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| -| `tailush.UseLabelClass()` | `<%= f.Label() %>` | block text-sm font-medium text-gray-700 | -| `tailush.UseInputClass()` | `<%= f.InputTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | -| `tailush.UseCheckboxClass()` | `<%= f.CheckboxTag() %>` | TBD | -| `tailush.UseRadioClass()` | `<%= f.RadioButtonTag() %>` | TBD | -| `tailush.UseFileClass()` | `<%= f.FileTag() %>` | TBD | -| `tailush.UseTextAreaClass()` | `<%= f.TextAreaTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full | -| `tailush.UseSelectClass()` | `<%= f.SelectTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full py-2 mt-1 text-base sm:text-sm | -| `tailush.UseDateInputClass()` | `<%= f.DateTimeTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | -| `tailush.UseFieldContainerClass()` | Not implemented yet | TBD | -| `tailush.UseErrorClass()` | Not implemented yet | TBD | +| Option ⚙️ |
Component ⚒️
| Used Classes | +|------------------------------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| `tailush.UseLabelClass()` | `<%= f.Label() %>` | block text-sm font-medium text-gray-700 | +| `tailush.UseInputClass()` | `<%= f.InputTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | +| `tailush.UseCheckboxClass()` | `<%= f.CheckboxTag() %>` | TBD | +| `tailush.UseRadioClass()` | `<%= f.RadioButtonTag() %>` | TBD | +| `tailush.UseFileClass()` | `<%= f.FileTag() %>` | TBD | +| `tailush.UseTextAreaClass()` | `<%= f.TextAreaTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full | +| `tailush.UseSelectClass()` | `<%= f.SelectTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full py-2 mt-1 text-base sm:text-sm | +| `tailush.UseDateInputClass()` | `<%= f.DateTimeTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | +| `tailush.UseFieldContainerClass()` | Not implemented yet | TBD | +| `tailush.UseErrorClass()` | Not implemented yet | TBD | From dd3825ce76e01eb1fa87c80095d56709a658219d Mon Sep 17 00:00:00 2001 From: Sam P Date: Mon, 6 Feb 2023 08:44:22 -0500 Subject: [PATCH 4/6] docs: bumping up width to 320 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c8a192..2bd2312 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Customizing the form helpers is done by passing different instances of `tailush. The following options are available for the form helpers: -| Option ⚙️ |
Component ⚒️
| Used Classes | +| Option ⚙️ |
Component ⚒️
| Used Classes | |------------------------------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | `tailush.UseLabelClass()` | `<%= f.Label() %>` | block text-sm font-medium text-gray-700 | | `tailush.UseInputClass()` | `<%= f.InputTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | From 25bb4c577c665494de8ea6fab87973e44e852a86 Mon Sep 17 00:00:00 2001 From: Samuel P Date: Mon, 6 Feb 2023 08:47:55 -0500 Subject: [PATCH 5/6] task: removing div as it doesn't work on github --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3c8a192..23626c4 100644 --- a/README.md +++ b/README.md @@ -49,17 +49,18 @@ Customizing the form helpers is done by passing different instances of `tailush. The following options are available for the form helpers: -| Option ⚙️ |
Component ⚒️
| Used Classes | -|------------------------------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| -| `tailush.UseLabelClass()` | `<%= f.Label() %>` | block text-sm font-medium text-gray-700 | -| `tailush.UseInputClass()` | `<%= f.InputTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | -| `tailush.UseCheckboxClass()` | `<%= f.CheckboxTag() %>` | TBD | -| `tailush.UseRadioClass()` | `<%= f.RadioButtonTag() %>` | TBD | -| `tailush.UseFileClass()` | `<%= f.FileTag() %>` | TBD | -| `tailush.UseTextAreaClass()` | `<%= f.TextAreaTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full | -| `tailush.UseSelectClass()` | `<%= f.SelectTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full py-2 mt-1 text-base sm:text-sm | -| `tailush.UseDateInputClass()` | `<%= f.DateTimeTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | -| `tailush.UseFieldContainerClass()` | Not implemented yet | TBD | -| `tailush.UseErrorClass()` | Not implemented yet | TBD | +| Option ⚙️ | Component ⚒️ | Used Classes | +|------------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| `tailush.UseLabelClass()` | `<%= f.Label() %>` | block text-sm font-medium text-gray-700 | +| `tailush.UseInputClass()` | `<%= f.InputTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | +| `tailush.UseCheckboxClass()` | `<%= f.CheckboxTag() %>` | TBD | +| `tailush.UseRadioClass()` | `<%= f.RadioButtonTag() %>` | TBD | +| `tailush.UseFileClass()` | `<%= f.FileTag() %>` | TBD | +| `tailush.UseTextAreaClass()` | `<%= f.TextAreaTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full | +| `tailush.UseSelectClass()` | `<%= f.SelectTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full py-2 mt-1 text-base sm:text-sm | +| `tailush.UseDateInputClass()` | `<%= f.DateTimeTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | +| `tailush.UseFieldContainerClass()` | Not implemented yet | TBD | +| `tailush.UseErrorClass()` | Not implemented yet | TBD | + From 8e7be4e28e0052397f2787a68c015862398f0f1f Mon Sep 17 00:00:00 2001 From: Sam P Date: Tue, 7 Feb 2023 13:28:10 -0500 Subject: [PATCH 6/6] docs: renamed column header --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 35fc6f0..c625a90 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Customizing the form helpers is done by passing different instances of `tailush. The following options are available for the form helpers: -| Option ⚙️ | Component ⚒️ | Used Classes | +| Option ⚙️ | Component ⚒️ | Default classes ✏️ | |------------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | `tailush.UseLabelClass()` | `<%= f.Label() %>` | block text-sm font-medium text-gray-700 | | `tailush.UseInputClass()` | `<%= f.InputTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | @@ -60,4 +60,4 @@ The following options are available for the form helpers: | `tailush.UseSelectClass()` | `<%= f.SelectTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 w-full py-2 mt-1 text-base sm:text-sm | | `tailush.UseDateInputClass()` | `<%= f.DateTimeTag() %>` | border border-gray-300 rounded-md py-1.5 px-3 focus:border-indigo-500 focus:outline-none focus:ring-indigo-500 text-sm font-medium text-gray-700 | | `tailush.UseFieldContainerClass()` | Not implemented yet | TBD | -| `tailush.UseErrorClass()` | Not implemented yet | TBD | \ No newline at end of file +| `tailush.UseErrorClass()` | Not implemented yet | TBD |