NoRedInk/noredink-ui
1
1
Fork 0
mirror of https://github.com/NoRedInk/noredink-ui.git synced 2024-11-28 10:17:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix missing doc comments

Browse Source
This commit is contained in:
Brian Hicks 2019-07-12 05:36:58 -05:00
parent b8d8957a24
commit dd902d6e5f
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/Nri/Ui/Heading/V1.elm
View File

@ -130,15 +130,7 @@ headingStyles config =
-- DOCUMENT LEVEL
{-| Customize the document level of the heading. For accessibility reasons, you
should have exactly one H1, and only increase the level by one. You can use a
tool like [axe](https://www.deque.com/axe/) to check this.
heading [ text "Hello, World!" ]
|> withDocumentLevel H1
|> view
-}
{-| -}
type DocumentLevel
= H1
| H2
@ -148,6 +140,15 @@ type DocumentLevel
| H6
{-| Customize the document level of the heading. For accessibility reasons, you
should have exactly one H1, and only increase the level by one. You can use a
tool like [axe](https://www.deque.com/axe/) to check this.
heading [ text "Hello, World!" ]
|> withDocumentLevel H1
|> view
-}
withDocumentLevel : DocumentLevel -> Heading msg -> Heading msg
withDocumentLevel documentLevel (Heading content visualLevel _) =
Heading content visualLevel documentLevel