docs on :for directive are missing information on index modifiers
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- elixir
- Domain
- documentation
Research direction
Start with the :for section at https://surface-ui.org/template_syntax and review the related cases in test/surface/integrations/directives_test.exs around lines 533-535. Document the supported index modifiers and add a few examples based on those tests; the documentation is done when it lists the modifiers and shows how to use them.
Written by the indexing model from the issue text.
Description
https://surface-ui.org/template_syntax
:for - Iterates over a list (generator) and renders the content of the tag (or component) for each item in the list.
But reading the test cases it clearly supports a handful of modifiers for accessing indexes. It would be nice if that was listed in the documentation and a few examples provided.
- Dominant language
- Elixir
- Stars
- 2.1k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from surface-ui/surface
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
surface-ui/surface#770 ·
-
Website is down Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
surface-ui/surface#768 · 4 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
surface-ui/surface#762 · 2 comments · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
surface-ui/surface#759 · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
surface-ui/surface#756 ·
All issues in surface-ui/surface
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
phoenixframework/phoenix#6847 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
beyond-all-reason/teiserver#1584 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ash-project/ash#2954 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
membraneframework/boombox#149 ·