Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[2.9.x] Updates Custom Field Constructor Documentation (backport #12892) by @RommelTJ #13125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 1 commit into from
Feb 18, 2025
Merged

[2.9.x] Updates Custom Field Constructor Documentation (backport #12892) by @RommelTJ #13125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions documentation/manual/working/scalaGuide/main/forms/ScalaCustomFieldConstructors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ This default field constructor supports additional options you can pass in the i

## Writing your own field constructor

Often you will need to write your own field constructor. Start by writing a template like:
Often you will need to write your own field constructor. Start by creating a file `app/views/helper/myFieldConstructorTemplate.scala.html`:

@[form-myfield](code/scalaguide/forms/scalafieldconstructor/myFieldConstructorTemplate.scala.html)

> **Note:** This is just a sample. You can make it as complicated as you need. You also have access to the original field using `@elements.field`.

Now create a [`FieldConstructor`](api/scala/views/html/helper/FieldConstructor.html) using this template function:
Now create a [`FieldConstructor`](api/scala/views/html/helper/FieldConstructor.html) using this template function in `app/views/helper/MyHelpers.scala`:

@[form-myfield-helper](code/ScalaFieldConstructor.scala)

Expand All @@ -53,3 +53,23 @@ You can also set an implicit value for your [`FieldConstructor`](api/scala/views
@[declare-implicit](code/scalaguide/forms/scalafieldconstructor/userDeclare.scala.html)

@[form](code/scalaguide/forms/scalafieldconstructor/userDeclare.scala.html)

## Example Project Structure

For reference, here's a simple project structure for implementing custom field constructors:

```
app/
├── controllers/
│ └── HomeController.scala
├── views/
│ ├── helper/
│ │ ├── myFieldConstructorTemplate.scala.html
│ │ └── MyHelpers.scala
│ ├── index.scala.html
│ └── main.scala.html
└── conf/
└── routes
```

This structure allows for easy organization and import of your custom field constructors across your Play application.
Loading