From 7df0165660a3db18ebcec7c02dcfd66f685f5f2b Mon Sep 17 00:00:00 2001 From: Katie Hughes Date: Fri, 22 May 2020 15:56:53 -0700 Subject: [PATCH] update doc comments --- src/Nri/Ui/SegmentedControl/V9.elm | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/Nri/Ui/SegmentedControl/V9.elm b/src/Nri/Ui/SegmentedControl/V9.elm index 7259315b..9659f271 100644 --- a/src/Nri/Ui/SegmentedControl/V9.elm +++ b/src/Nri/Ui/SegmentedControl/V9.elm @@ -46,7 +46,13 @@ type alias NavConfig a msg = } -{-| Same shape as NavConfig but without the content +{-| + + - `onClick` : the message to produce when an option is selected (clicked) by the user + - `options`: the list of options available + - `selected`: if present, the value of the currently-selected option + - `width`: how to size the segmented control + -} type alias SelectConfig a msg = { onClick : a -> msg @@ -88,7 +94,8 @@ viewSpa toUrl config = viewHelper (Just toUrl) config -{-| Creates _just the toggle_ when need the ui element itself and not a page control +{-| Creates _just the segmented select_ when you need the ui element itself and +not a page control -} viewSelect : SelectConfig a msg -> Html msg viewSelect config =