[ { "name": "Nri.Ui.TextArea.V1", "comment": "\n\n\n## The Nri styleguide-specified textarea with overlapping label\n\n@docs view, writing, contentCreation, Model, generateId, styles\n\n", "unions": [], "aliases": [ { "name": "Model", "comment": " ", "args": [ "msg" ], "type": "{ value : String, autofocus : Bool, onInput : String -> msg, isInError : Bool, autoResize : Bool, placeholder : String, label : String, showLabel : Bool }" } ], "values": [ { "name": "contentCreation", "comment": " Used for Content Creation\n", "type": "Model msg -> Html msg" }, { "name": "generateId", "comment": " ", "type": "String -> String" }, { "name": "styles", "comment": " ", "type": "StylesWithAssets Never CssClasses msg (Assets r)" }, { "name": "view", "comment": " ", "type": "Model msg -> Html msg" }, { "name": "writing", "comment": " Used for Writing Cycles\n", "type": "Model msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Outline.V1", "comment": " A module for rendering outline layouts.\n\n@docs segment\n@docs node\n@docs NodeLayout\n@docs NodeConfig\n@docs config\n@docs html\n@docs styles\n\n", "unions": [ { "name": "NodeLayout", "comment": " A wrapper for a node rendered into Html. This type exists to prevent us\nfrom accidentally wrapping a node in a container element before passing it as a\nchild to another node or segment. Such wrapping would break some of our\nstyling, which assumes nodes of the same level are sibblings in the Html tree.\n", "args": [ "msg" ], "cases": [] } ], "aliases": [ { "name": "NodeConfig", "comment": " Defines how a node should look.\n", "args": [ "msg" ], "type": "{ label : Html msg, contents : Html msg, children : List (NodeLayout msg), selected : Bool, ghosted : Bool, attrs : List (Attribute msg) }" } ], "values": [ { "name": "config", "comment": " A default node configuration, allowing you to only set the properties you care about.\n\n node { config | label = \"Claim\" }\n\n", "type": "NodeConfig msg" }, { "name": "html", "comment": " Wrap any html in a NodeLayout so you can use it as sibling content to nodes.\n\n segment\n [ node { config | label = \"This is a node\" }\n , html (Html.text \"This is some random Html content!\")\n ]\n\n", "type": "Html msg -> NodeLayout msg" }, { "name": "node", "comment": " Draw a node of an outline structure. You can draw other nodes inside it and\nconnecting lines will appear.\n\n node { config | label = \"Claim\" }\n\n", "type": "NodeConfig msg -> NodeLayout msg" }, { "name": "segment", "comment": " A container to draw nodes in.\n\n segment\n [ node { config | label = \"First Node\" }\n , node { config | label = \"Second Node\" }\n ]\n\n", "type": "List (NodeLayout msg) -> Html msg" }, { "name": "styles", "comment": " Styles used by outline structures.\n", "type": "Styles a Style b" } ], "binops": [] }, { "name": "Nri.Ui.SegmentedControl.V3", "comment": "\n\n@docs Config, Icon, Option, styles, view, CssClass\n\n", "unions": [ { "name": "CssClass", "comment": " Classes for styling\n", "args": [], "cases": [] } ], "aliases": [ { "name": "Config", "comment": " ", "args": [ "a", "msg" ], "type": "{ onClick : a -> msg, options : List (Option a), selected : a }" }, { "name": "Icon", "comment": " ", "args": [], "type": "{ alt : String, icon : IconType }" }, { "name": "Option", "comment": " ", "args": [ "a" ], "type": "{ value : a, icon : Maybe Icon, label : String, id : String }" } ], "values": [ { "name": "styles", "comment": " ", "type": "Styles Never CssClass msg" }, { "name": "view", "comment": " ", "type": "Assets r -> Config a msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.SegmentedControl.V5", "comment": "\n\n@docs Config, Icon, Option, styles, view, CssClass\n\n", "unions": [ { "name": "CssClass", "comment": " Classes for styling\n", "args": [], "cases": [] } ], "aliases": [ { "name": "Config", "comment": " ", "args": [ "a", "msg" ], "type": "{ onClick : a -> msg, options : List (Option a), selected : a }" }, { "name": "Icon", "comment": " ", "args": [], "type": "{ alt : String, icon : IconType }" }, { "name": "Option", "comment": " ", "args": [ "a" ], "type": "{ value : a, icon : Maybe Icon, label : String, id : String }" } ], "values": [ { "name": "styles", "comment": " ", "type": "Styles Never CssClass msg" }, { "name": "view", "comment": " ", "type": "Config a msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.SegmentedControl.V4", "comment": "\n\n@docs Config, Icon, Option, styles, view, CssClass\n\n", "unions": [ { "name": "CssClass", "comment": " Classes for styling\n", "args": [], "cases": [] } ], "aliases": [ { "name": "Config", "comment": " ", "args": [ "a", "msg" ], "type": "{ onClick : a -> msg, options : List (Option a), selected : a }" }, { "name": "Icon", "comment": " ", "args": [], "type": "{ alt : String, icon : IconType }" }, { "name": "Option", "comment": " ", "args": [ "a" ], "type": "{ value : a, icon : Maybe Icon, label : String, id : String }" } ], "values": [ { "name": "styles", "comment": " ", "type": "Styles Never CssClass msg" }, { "name": "view", "comment": " ", "type": "Config a msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Alert.V1", "comment": " UI components that highlight information to the user.\n\n@docs Model\n@docs error\n@docs styles\n@docs success\n@docs tip\n@docs viewResult\n@docs warning\n\n", "unions": [], "aliases": [ { "name": "Model", "comment": " ", "args": [], "type": "{ content : String }" } ], "values": [ { "name": "error", "comment": " ", "type": "Model -> Html msg" }, { "name": "styles", "comment": " ", "type": "Styles Never CssClasses msg" }, { "name": "success", "comment": " ", "type": "Model -> Html msg" }, { "name": "tip", "comment": " ", "type": "Model -> Html msg" }, { "name": "viewResult", "comment": " Show either an error or success alert depending on the given Result\n", "type": "Result String String -> Html msg" }, { "name": "warning", "comment": " ", "type": "Model -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Tabs.V1", "comment": "\n\n@docs Alignment\n@docs Config\n@docs LinkConfig\n@docs Tab\n@docs TabLink\n@docs links\n@docs styles\n@docs view\n@docs viewCustom\n\n\n## Defaults\n\n@docs viewTabDefault\n\n", "unions": [ { "name": "Alignment", "comment": " Determines whether tabs are centered or floating to the left or right.\n", "args": [], "cases": [ [ "Left", [] ], [ "Center", [] ], [ "Right", [] ] ] } ], "aliases": [ { "name": "Config", "comment": " ", "args": [ "id", "msg" ], "type": "{ title : Maybe String, onSelect : id -> msg, tabs : Zipper (Tab id), content : id -> Html msg, alignment : Alignment }" }, { "name": "LinkConfig", "comment": " Configure a set a tab links\n", "args": [ "msg" ], "type": "{ title : Maybe String, tabs : Zipper TabLink, content : Html msg, alignment : Alignment }" }, { "name": "Tab", "comment": " ", "args": [ "id" ], "type": "{ label : String, id : id }" }, { "name": "TabLink", "comment": " Describe a tab that is meant to link to another page\n", "args": [], "type": "{ label : String, href : Maybe String }" } ], "values": [ { "name": "links", "comment": " View a set of tab links\n", "type": "LinkConfig msg -> Html msg" }, { "name": "styles", "comment": " ", "type": "Styles Never CssClasses msg" }, { "name": "view", "comment": " ", "type": "Config id msg -> Html msg" }, { "name": "viewCustom", "comment": " ", "type": "Config id msg -> (Tab id -> Html msg) -> Html msg" }, { "name": "viewTabDefault", "comment": " ", "type": "Tab id -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Text.V1", "comment": "\n\n@docs styles\n\n\n## Semantic text types:\n\n@docs caption, heading, mediumBody, smallBody, smallBodyGray, subHeading, smallHeading, tagline\n\n\n## User-generated text styles:\n\n@docs ugMediumBody,ugSmallBody\n\n\n## Text class strings:\n\n@docs captionClassString, mediumBodyClassString, smallBodyClassString\n\n\n## Modifying strings to display nicely:\n\n@docs noWidow\n\n", "unions": [], "aliases": [], "values": [ { "name": "caption", "comment": " This is a little note or caption.\n", "type": "List (Html msg) -> Html msg" }, { "name": "captionClassString", "comment": " Stringified version of `captionClasses`.\nNecessary because \n", "type": "String" }, { "name": "heading", "comment": " This is a Page Heading.\n", "type": "List (Html msg) -> Html msg" }, { "name": "mediumBody", "comment": " This is some medium body copy.\n", "type": "List (Html msg) -> Html msg" }, { "name": "mediumBodyClassString", "comment": " Stringified version of `mediumBodyClasses`.\nNecessary because \n", "type": "String" }, { "name": "noWidow", "comment": " Eliminate widows (single words on their own line caused by\nwrapping) by inserting a non-breaking space if there are at least two\nwords.\n", "type": "String -> String" }, { "name": "smallBody", "comment": " This is some small body copy.\n", "type": "List (Html msg) -> Html msg" }, { "name": "smallBodyClassString", "comment": " Stringified version of `smallBodyClasses`.\nNecessary because \n", "type": "String" }, { "name": "smallBodyGray", "comment": " This is some small body copy but it's gray.\n", "type": "List (Html msg) -> Html msg" }, { "name": "smallHeading", "comment": " This is a small Page Heading.\n", "type": "List (Html msg) -> Html msg" }, { "name": "styles", "comment": " ", "type": "Styles Never CssClasses msg" }, { "name": "subHeading", "comment": " This is a subhead.\n", "type": "List (Html msg) -> Html msg" }, { "name": "tagline", "comment": " This is a tagline for a page heading.\n", "type": "List (Html msg) -> Html msg" }, { "name": "ugMediumBody", "comment": " User-generated text.\n", "type": "List (Html msg) -> Html msg" }, { "name": "ugSmallBody", "comment": " User-generated text.\n", "type": "List (Html msg) -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.SegmentedControl.V2", "comment": "\n\n@docs Config, Option, styles, view\n\n", "unions": [], "aliases": [ { "name": "Config", "comment": " ", "args": [ "a", "msg" ], "type": "{ onClick : a -> msg, options : List (Option a), selected : a }" }, { "name": "Option", "comment": " ", "args": [ "a" ], "type": "{ value : a, label : String, id : String }" } ], "values": [ { "name": "styles", "comment": " ", "type": "Styles Never CssClass msg" }, { "name": "view", "comment": " ", "type": "Config a msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.SegmentedControl.V1", "comment": "\n\n@docs Config, Option, styles, view\n\n", "unions": [], "aliases": [ { "name": "Config", "comment": " ", "args": [ "a", "msg" ], "type": "{ onClick : a -> msg, options : List (Option a), selected : a }" }, { "name": "Option", "comment": " ", "args": [ "a" ], "type": "{ value : a, label : String, id : String }" } ], "values": [ { "name": "styles", "comment": " ", "type": "Styles Never CssClass msg" }, { "name": "view", "comment": " ", "type": "Config a msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Palette.V1", "comment": " Predefined color palettes for use in configurable components\n\n@docs Palette, PaletteName\n@docs white, gray, darkGray, blue, darkBlue, purple, turquoise, green, red, aqua, cornflower\n\n", "unions": [ { "name": "PaletteName", "comment": " ", "args": [], "cases": [ [ "Gray", [] ], [ "DarkGray", [] ], [ "Blue", [] ], [ "DarkBlue", [] ], [ "Purple", [] ], [ "Turquoise", [] ], [ "Red", [] ], [ "Green", [] ], [ "White", [] ], [ "Cornflower", [] ], [ "Aqua", [] ] ] } ], "aliases": [ { "name": "Palette", "comment": " ", "args": [], "type": "{ border : Color, background : Color, primary : Color, name : PaletteName }" } ], "values": [ { "name": "aqua", "comment": " Aqua palette\n", "type": "Palette" }, { "name": "blue", "comment": " Blue palette\n", "type": "Palette" }, { "name": "cornflower", "comment": " Cornflower palette\n", "type": "Palette" }, { "name": "darkBlue", "comment": " Dark blue palette\n", "type": "Palette" }, { "name": "darkGray", "comment": " Dark Gray palette\n", "type": "Palette" }, { "name": "gray", "comment": " Gray palette\n", "type": "Palette" }, { "name": "green", "comment": " Green palette\n", "type": "Palette" }, { "name": "purple", "comment": " Purple palette\n", "type": "Palette" }, { "name": "red", "comment": " Red palette\n", "type": "Palette" }, { "name": "turquoise", "comment": " Turquoise palette\n", "type": "Palette" }, { "name": "white", "comment": " White palette (borders are blue)\n", "type": "Palette" } ], "binops": [] }, { "name": "Nri.Ui.Modal.V1", "comment": "\n\n@docs Model\n@docs info\n@docs styles\n@docs warning\n\n", "unions": [], "aliases": [ { "name": "Model", "comment": "\n\n - `onDismiss`: If `Nothing`, the modal will not be dismissable\n - `visibleTitle`: If `False`, the title will still be used for screen readers\n - `content`: This will be placed in a `width:100%` div in the main area of the modal\n - `footerContent`: The optional items here will be stacked below the main content area and center-aligned.\n Commonly you will either give a list of Nri.Ui.Buttons,\n or an empty list.\n\n", "args": [ "msg" ], "type": "{ title : String, visibleTitle : Bool, content : Html msg, footerContent : List (Html msg), onDismiss : Maybe msg, width : Maybe Int }" } ], "values": [ { "name": "info", "comment": " ", "type": "Model msg -> Html msg" }, { "name": "styles", "comment": " ", "type": "Styles Never CssClasses b" }, { "name": "warning", "comment": " ", "type": "Model msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Text.Writing.V1", "comment": " Text types for writing:\n\n@docs footnote\n\n", "unions": [], "aliases": [], "values": [ { "name": "footnote", "comment": " This is a little note or footnote.\n", "type": "List (Html msg) -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Effects.V1", "comment": " Css mixins reused across Nri modules.\n\n@docs selectionShadow\n\n", "unions": [], "aliases": [], "values": [ { "name": "selectionShadow", "comment": " Draw a 2 px thick ochre border around the element to indicate it is\nselected.\n\nThis uses a CSS box shadow to draw what looks like a border. Box shadows are\nperfect for this because they don't affect the elements positioning in any way.\nThis means we can be sure switching the selection shadow on and off is not\ngoing to make the element jump.\n\n", "type": "List Style" } ], "binops": [] }, { "name": "Nri.Ui.Icon.V1", "comment": "\n\n@docs icon, decorativeIcon, link, linkExternal, button\n@docs IconType, AssignmentType, IconSize\n@docs styles, CssClasses\n@docs Assets\n\n", "unions": [ { "name": "AssignmentType", "comment": " Icons describing Assignment Types.\n", "args": [], "cases": [ [ "Diagnostic", [] ], [ "Practice", [] ], [ "Quiz", [] ], [ "WritingCycle", [] ] ] }, { "name": "CssClasses", "comment": " Classes for styling\n", "args": [], "cases": [] }, { "name": "IconSize", "comment": " Used for determining sizes on Icon.buttons and Icon.links\n", "args": [], "cases": [ [ "Small", [] ], [ "Medium", [] ] ] }, { "name": "IconType", "comment": " ", "args": [], "cases": [ [ "Activity", [] ], [ "Add", [] ], [ "ArrowDown", [] ], [ "ArrowLeft", [] ], [ "ArrowRight", [] ], [ "AssignmentType", [ "AssignmentType" ] ], [ "Attention", [] ], [ "Bang", [] ], [ "Bulb", [] ], [ "Calendar", [] ], [ "Caret", [] ], [ "CheckMark", [] ], [ "CheckMarkSquiggily", [] ], [ "CheckMarkSvg", [] ], [ "Class", [] ], [ "Clever", [] ], [ "Clock", [] ], [ "Close", [] ], [ "CompassSvg", [] ], [ "Copy", [] ], [ "Custom", [ "String", "String" ] ], [ "DarkBlueCheckMark", [] ], [ "Document", [] ], [ "Download", [] ], [ "Edit", [] ], [ "EditWriting", [] ], [ "EqualitySign", [] ], [ "Exclamation", [] ], [ "Facebook", [] ], [ "Flag", [] ], [ "Flipper", [] ], [ "Footsteps", [] ], [ "Gardening", [] ], [ "Gear", [] ], [ "GreenCheckMark", [] ], [ "Help", [] ], [ "HighFive", [] ], [ "Key", [] ], [ "Late", [] ], [ "Leaderboard", [] ], [ "LightBulb", [] ], [ "Lock", [] ], [ "LockDeprecated", [] ], [ "Logo", [] ], [ "Newspaper", [] ], [ "NotStarred", [] ], [ "Okay", [] ], [ "OpenClose", [] ], [ "PeerReview", [] ], [ "Performance", [] ], [ "PersonBlue", [] ], [ "Preview", [] ], [ "QuickWrite", [] ], [ "SeeMore", [] ], [ "Share", [] ], [ "Sort", [] ], [ "SortArrow", [] ], [ "Speedometer", [] ], [ "Starred", [] ], [ "ThumbsUp", [] ], [ "Twitter", [] ], [ "Unarchive", [] ], [ "WritingAssignment", [] ], [ "X", [] ], [ "XSvg", [] ] ] } ], "aliases": [ { "name": "Assets", "comment": " ", "args": [ "r" ], "type": "{ r | activity : String, arrowDown : String, attention_svg : Asset, bulb : String, calendar : String, checkmark : String, class : String, clever : String, clock : String, commentNotStarred_png : Asset, commentStarred_png : Asset, compass : String, darkBlueCheckmark_svg : Asset, diagnostic : String, document : String, download : String, edit : String, editWriting : String, exclamation : String, exclamationPoint_svg : Asset, facebookBlue_svg : Asset, flipper : String, footsteps : String, gear : String, hint_png : Asset, iconCheck_png : Asset, iconFlag_png : Asset, icons_arrowDownBlue_svg : Asset, icons_arrowRightBlue_svg : Asset, icons_clockRed_svg : Asset, icons_equals_svg : Asset, icons_helpBlue_svg : Asset, icons_peerReview_svg : Asset, icons_plusBlue_svg : Asset, icons_quickWrite_svg : Asset, icons_xBlue_svg : Asset, key : String, leaderboard : String, leftArrowBlue_png : Asset, level1Badge_png : Asset, level2Badge_png : Asset, level3Badge_png : Asset, lock : String, logoRedBlack_svg : Asset, newspaper : String, openClose : String, performance : String, personBlue_svg : Asset, practice : String, premiumLock_svg : Asset, preview : String, quiz : String, seemore : String, share : String, smallCheckmark_png : Asset, sort : String, sortArrow : String, speedometer : String, squiggly_png : Asset, startingOffBadge_png : Asset, teach_assignments_copyWhite_svg : Asset, twitterBlue_svg : Asset, unarchiveBlue2x_png : Asset, writingAssignment : String, writingcycle : String, x : String, xWhite_svg : Asset }" } ], "values": [ { "name": "button", "comment": " Create an accessible icon button with an onClick handler\nUses our default icon styles (25 x 25 px, azure)\n", "type": "Assets r -> IconButtonModel msg -> Html msg" }, { "name": "decorativeIcon", "comment": " Use this icon for purely decorative content that would be distracting\nrather than helpful on a screenreader.\n", "type": "Assets r -> IconType -> Html msg" }, { "name": "icon", "comment": " ", "type": "Assets r -> { alt : String, icon : IconType } -> Html msg" }, { "name": "link", "comment": " Create an icon that links to a part of NRI\nUses our default icon styles (25 x 25 px, azure)\n", "type": "Assets r -> IconLinkModel -> Html msg" }, { "name": "linkExternal", "comment": " Create an icon that links to an external site\nUses our default icon styles (25 x 25 px, azure)\n", "type": "Assets r -> IconLinkModel -> Html msg" }, { "name": "styles", "comment": " ", "type": "Styles Never CssClasses msg" } ], "binops": [] }, { "name": "Nri.Ui.Divider.V1", "comment": " \n\n@docs styles, view\n\n", "unions": [], "aliases": [], "values": [ { "name": "styles", "comment": " ", "type": "Styles Never CssClasses msg" }, { "name": "view", "comment": " ", "type": "String -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.TextInput.V1", "comment": "\n\n@docs InputType\n@docs Model\n@docs styles\n@docs view\n@docs withInvisibleLabel\n\n\n## Input types\n\n@docs number\n@docs text\n\n", "unions": [ { "name": "InputType", "comment": " ", "args": [ "value" ], "cases": [] } ], "aliases": [ { "name": "Model", "comment": " ", "args": [ "value", "msg" ], "type": "{ label : String, isInError : Bool, onInput : value -> msg, placeholder : String, value : value, autofocus : Bool, type_ : InputType value }" } ], "values": [ { "name": "number", "comment": " An input that allows number entry\n", "type": "InputType (Maybe Int)" }, { "name": "styles", "comment": " ", "type": "Styles Never CssClasses msg" }, { "name": "text", "comment": " An input that allows text entry\n", "type": "InputType String" }, { "name": "view", "comment": " ", "type": "Model value msg -> Html msg" }, { "name": "withInvisibleLabel", "comment": " ", "type": "Model value msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Checkbox.V2", "comment": "\n\n@docs Model, Theme, ColorTheme\n\n@docs view, viewWithLabel, viewAttention, disabled\n@docs IsSelected\n@docs keyframeCss, styles\n\n\n## Premium\n\n@docs PremiumConfig, premium\n\n", "unions": [ { "name": "ColorTheme", "comment": " ", "args": [], "cases": [ [ "Default", [] ], [ "Gray", [] ], [ "Orange", [] ] ] }, { "name": "IsSelected", "comment": " ", "args": [], "cases": [ [ "Selected", [] ], [ "NotSelected", [] ], [ "PartiallySelected", [] ] ] }, { "name": "Theme", "comment": " ", "args": [], "cases": [ [ "Square", [ "ColorTheme" ] ], [ "Round", [] ], [ "Locked", [] ], [ "LockOnInside", [] ], [ "Unlockable", [] ], [ "Disabled", [] ], [ "Premium", [] ] ] } ], "aliases": [ { "name": "Model", "comment": "\n\n - isChecked : Maybe Bool\n - Just True == Checked (rendered checkmark)\n - Just False == Not Checked (rendered blank)\n - Nothing == Indeterminate (rendered dash)\n\n", "args": [ "msg" ], "type": "{ identifier : String, label : String, setterMsg : Bool -> msg, isChecked : Maybe Bool, disabled : Bool, theme : Theme, noOpMsg : msg }" }, { "name": "PremiumConfig", "comment": "\n\n - `onChange`: A message for when the user toggles the checkbox\n - `onLockedClick`: A message for when the user clicks a checkbox they don't have PremiumLevel for.\n If you get this message, you should show an `Nri.Ui.Premium.Model.view`\n\n", "args": [ "msg" ], "type": "{ label : String, id : String, selected : IsSelected, disabled : Bool, teacherPremiumLevel : PremiumLevel, contentPremiumLevel : PremiumLevel, showFlagWhenLocked : Bool, onChange : Bool -> msg, onLockedClick : msg, noOpMsg : msg }" } ], "values": [ { "name": "disabled", "comment": " Show a disabled checkbox.\n", "type": "String -> String -> Html msg" }, { "name": "keyframeCss", "comment": " ", "type": "Keyframe" }, { "name": "premium", "comment": " A checkbox that should be used for premium content\n\nThis checkbox is locked when the premium level of the content is greater than the premium level of the teacher\n\n", "type": "PremiumConfig msg -> Html msg" }, { "name": "styles", "comment": " ", "type": "StylesWithAssets Never CssClasses msg (Assets r)" }, { "name": "view", "comment": " Shows a checkbox (the label is only used for accessibility hints)\n", "type": "Model msg -> Html msg" }, { "name": "viewAttention", "comment": " ", "type": "Model msg -> Html msg" }, { "name": "viewWithLabel", "comment": " Shows a checkbox and its label text\n", "type": "Model msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Checkbox.V1", "comment": "\n\n@docs Model, Theme, ColorTheme\n\n@docs view, viewWithLabel, viewAttention, disabled\n@docs IsSelected\n@docs keyframeCss, styles\n\n\n## Premium\n\n@docs PremiumConfig, premium\n\n", "unions": [ { "name": "ColorTheme", "comment": " ", "args": [], "cases": [ [ "Default", [] ], [ "Gray", [] ], [ "Orange", [] ] ] }, { "name": "IsSelected", "comment": " ", "args": [], "cases": [ [ "Selected", [] ], [ "NotSelected", [] ], [ "PartiallySelected", [] ] ] }, { "name": "Theme", "comment": " ", "args": [], "cases": [ [ "Square", [ "ColorTheme" ] ], [ "Round", [ "Bool" ] ], [ "Locked", [] ], [ "LockOnInside", [] ], [ "Unlockable", [] ], [ "Disabled", [] ], [ "Premium", [] ] ] } ], "aliases": [ { "name": "Model", "comment": "\n\n - isChecked : Maybe Bool\n - Just True == Checked (rendered checkmark)\n - Just False == Not Checked (rendered blank)\n - Nothing == Indeterminate (rendered dash)\n\n", "args": [ "msg" ], "type": "{ identifier : String, label : String, setterMsg : Bool -> msg, isChecked : Maybe Bool, disabled : Bool, theme : Theme, noOpMsg : msg }" }, { "name": "PremiumConfig", "comment": "\n\n - `onChange`: A message for when the user toggles the checkbox\n - `onLockedClick`: A message for when the user clicks a checkbox they don't have PremiumLevel for.\n If you get this message, you should show an `Nri.Ui.Premium.Model.view`\n\n", "args": [ "msg" ], "type": "{ label : String, id : String, selected : IsSelected, disabled : Bool, teacherPremiumLevel : PremiumLevel, contentPremiumLevel : PremiumLevel, showFlagWhenLocked : Bool, onChange : Bool -> msg, onLockedClick : msg, noOpMsg : msg }" } ], "values": [ { "name": "disabled", "comment": " Show a disabled checkbox.\n", "type": "String -> String -> Html msg" }, { "name": "keyframeCss", "comment": " ", "type": "Keyframe" }, { "name": "premium", "comment": " A checkbox that should be used for premium content\n\nThis checkbox is locked when the premium level of the content is greater than the premium level of the teacher\n\n", "type": "PremiumConfig msg -> Html msg" }, { "name": "styles", "comment": " ", "type": "StylesWithAssets Never CssClasses msg (Assets r)" }, { "name": "view", "comment": " Shows a checkbox (the label is only used for accessibility hints)\n", "type": "Model msg -> Html msg" }, { "name": "viewAttention", "comment": " ", "type": "Model msg -> Html msg" }, { "name": "viewWithLabel", "comment": " Shows a checkbox and its label text\n", "type": "Model msg -> Html msg" } ], "binops": [] }, { "name": "Nri.Ui.Button.V1", "comment": " Common NoRedInk buttons. For accessibility purposes, buttons that perform an\naction on the current page should be HTML `