craftcms / craftcms/docs

_includes/forms macro documentation

Open
#179 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
42
Forks
160
Avg merge
3h 9m
Merged PRs (30d)
4

Description

Description

I'm trying to look for any form of documentation to use the forms. macros within _includes/forms but am unable to find any.

Looking through the Twig itself I can kind of see what fields and attributes are available, but not all of them match up e.g. there's a 'name' when rendering a field, but no attribute of 'name' in _includes/field.html (guessing it translates to 'id' instead).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the Twig macros under _includes/forms and compare their rendered fields with _includes/field.html, focusing on the differing attributes such as name and id. Done means the available fields and attributes, including their mappings, are documented for users.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.