NoRedInk/noredink-ui
1
1
Fork 0
mirror of https://github.com/NoRedInk/noredink-ui.git synced 2024-09-22 12:48:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Aaron VonderHaar 2020-04-28 13:33:03 -07:00
parent dc50b07a5e
commit 318f662035
5 changed files with 60 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
script/deprecated-imports.csv
View File

@ -15,7 +15,6 @@ src/Nri/Ui/SlideModal/V2.elm,Nri.Ui.Text,2
src/Nri/Ui/SlideModal/V1.elm,Nri.Ui.Button,8
src/Nri/Ui/SlideModal/V1.elm,Nri.Ui.Icon,3
src/Nri/Ui/SlideModal/V1.elm,Nri.Ui.Text,2
src/Nri/Ui/Alert/V4.elm,Nri.Ui.Icon,3
src/Nri/Ui/SortableTable/V1.elm,Nri.Ui.Table,4
src/Nri/Ui/Html/Attributes/Extra.elm,Html,DEPRECATED
src/Nri/Ui/Button/V8.elm,Html,DEPRECATED

1 filename name version
15 src/Nri/Ui/SlideModal/V1.elm Nri.Ui.Button 8
16 src/Nri/Ui/SlideModal/V1.elm Nri.Ui.Icon 3
17 src/Nri/Ui/SlideModal/V1.elm Nri.Ui.Text 2
src/Nri/Ui/Alert/V4.elm Nri.Ui.Icon 3
18 src/Nri/Ui/SortableTable/V1.elm Nri.Ui.Table 4
19 src/Nri/Ui/Html/Attributes/Extra.elm Html DEPRECATED
20 src/Nri/Ui/Button/V8.elm Html DEPRECATED

35
src/Nri/Ui/Alert/V4.elm
View File

@ -6,6 +6,9 @@ module Nri.Ui.Alert.V4 exposing
{-|
# DEPRECATED: Use `Nri.Ui.Message.V1.tiny` instead
# Changes from V3:
- Changes the error font color from `purpleDark` to `purple`
@ -30,12 +33,16 @@ import Markdown
import Nri.Ui
import Nri.Ui.Colors.V1 as Colors
import Nri.Ui.Fonts.V1 as Fonts
import Nri.Ui.Icon.V3 as Icon
import Nri.Ui.SpriteSheet exposing (bulb, checkmark, exclamationMark)
import Nri.Ui.Svg.V1 as NriSvg exposing (Svg)
{-| -}
{-|
# DEPRECATED: Use `Nri.Ui.Message.V1.somethingWentWrong` instead
-}
somethingWentWrong : String -> Html msg
somethingWentWrong errorMessageForEngineers =
Html.div []
@ -68,10 +75,10 @@ somethingWentWrong errorMessageForEngineers =
]
{-| import Nri.Ui.Alert.V4 as Alert
{-|
view =
Alert.error "Some **awesome** message!"
# DEPRECATED: Use `Nri.Ui.Message.V1.tiny Error` instead
-}
error : String -> Html msg
@ -82,10 +89,10 @@ error content =
]
{-| import Nri.Ui.Alert.V4 as Alert
{-|
view =
Alert.success "Some **awesome** message!"
# DEPRECATED: Use `Nri.Ui.Message.V1.tiny Success` instead
-}
success : String -> Html msg
@ -103,10 +110,10 @@ success content =
]
{-| import Nri.Ui.Alert.V4 as Alert
{-|
view =
Alert.tip "Some **awesome** message!"
# DEPRECATED: Use `Nri.Ui.Message.V1.tiny Tip` instead
-}
tip : String -> Html msg
@ -117,10 +124,10 @@ tip content =
]
{-| import Nri.Ui.Alert.V4 as Alert
{-|
view =
Alert.warning "Some **awesome** message!"
# DEPRECATED: Use `Nri.Ui.Message.V1.tiny Alert` instead
-}
warning : String -> Html msg

35
src/Nri/Ui/BannerAlert/V6.elm
View File

@ -5,6 +5,9 @@ module Nri.Ui.BannerAlert.V6 exposing
{-|
# DEPRECATED: Use `Nri.Ui.Message.V1.banner` instead
@docs alert, error, neutral, success
@docs custom
@ -24,7 +27,7 @@ import Accessibility.Styled as Html exposing (Html)
import Accessibility.Styled.Widget as Widget
import Css
import Css.Global
import Html.Styled.Attributes as Attributes exposing (css)
import Html.Styled.Attributes exposing (css)
import Html.Styled.Events
import Nri.Ui
import Nri.Ui.Colors.V1 as Colors
@ -33,7 +36,11 @@ import Nri.Ui.Svg.V1 as Svg exposing (Svg)
import Nri.Ui.UiIcon.V1 as UiIcon
{-| A banner to show error alerts
{-|
# DEPRECATED: Use `Nri.Ui.Message.V1.banner Alert` instead
-}
alert : List (Html msg) -> Maybe msg -> Html msg
alert content maybeDismiss =
@ -52,7 +59,11 @@ alert content maybeDismiss =
}
{-| A banner to show error alerts
{-|
# DEPRECATED: Use `Nri.Ui.Message.V1.banner Error` instead
-}
error : List (Html msg) -> Maybe msg -> Html msg
error content maybeDismiss =
@ -71,7 +82,11 @@ error content maybeDismiss =
}
{-| A banner to show neutral alerts
{-|
# DEPRECATED: Use `Nri.Ui.Message.V1.banner Tip` instead
-}
neutral : List (Html msg) -> Maybe msg -> Html msg
neutral content maybeDismiss =
@ -90,7 +105,11 @@ neutral content maybeDismiss =
}
{-| A banner for success alerts
{-|
# DEPRECATED: Use `Nri.Ui.Message.V1.banner Success` instead
-}
success : List (Html msg) -> Maybe msg -> Html msg
success content maybeDismiss =
@ -109,7 +128,11 @@ success content maybeDismiss =
}
{-| Use to construct a custom banner. Prefer to use a pre-made banner when possible.
{-|
# DEPRECATED: Use `Nri.Ui.Message.V1.banner Custom` instead
-}
custom :
{ color : Css.Color

3
src/Nri/Ui/Callout/V1.elm
View File

@ -7,6 +7,9 @@ module Nri.Ui.Callout.V1 exposing
{-|
# DEPRECATED: talk with your designer, but generally prefer `Message.large`, or consider adding `Message.medium`
@docs Attribute, callout
@docs label

9
styleguide-app/Examples/Callout.elm
View File

@ -6,12 +6,14 @@ module Examples.Callout exposing (example, State, Msg)
-}
import Accessibility.Styled exposing (text)
import Category exposing (Category(..))
import Css
import Example exposing (Example)
import Html.Styled as Html
import Html.Styled.Attributes exposing (href, title)
import Nri.Ui.Callout.V1 as Callout exposing (callout)
import Nri.Ui.Heading.V2 as Heading
type alias State =
@ -32,8 +34,11 @@ example =
, update = \_ state -> ( state, Cmd.none )
, subscriptions = \_ -> Sub.none
, view =
\_ ->
[ -- PLAIN
\() ->
[ Heading.h2 [ Heading.style Heading.Top ]
[ text "DEPRECATED: talk with your designer, but generally prefer `Message.large`, or consider adding `Message.medium`"
]
, -- PLAIN
Html.h3 [] [ Html.text "Originally Designed Use Case" ]
, callout
[ Callout.label (Html.text "BETA")