@instructure/ui-billboard 11.6.0 → 11.6.1-snapshot-129

package/src/Billboard/v2/props.ts

@@ -0,0 +1,128 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import type {
+  Spacing,
+  WithStyleProps,
+  ComponentStyle
+} from '@instructure/emotion'
+import type {
+  AsElementType,
+  BillboardTheme,
+  OtherHTMLAttributes
+} from '@instructure/shared-types'
+import type { ViewProps } from '@instructure/ui-view/latest'
+import { MouseEvent } from 'react'
+import { Renderable } from '@instructure/shared-types'
+type HeroIconSize = 'medium' | 'x-large' | 'large'
+type BillboardOwnProps = {
+  /**
+   * Provide an <Img> component or Instructure Icon for the hero image
+   */
+  hero?: React.ReactElement | ((iconSize?: HeroIconSize) => React.ReactElement)
+  /**
+   * If you're using an icon, this prop will size it. Also sets the font-size
+   * of the headline and message.
+   */
+  size?: 'small' | 'medium' | 'large'
+  /**
+   * the element type to render as
+   */
+  as?: AsElementType
+  /**
+   * provides a reference to the underlying html root element
+   */
+  elementRef?: (element: Element | null) => void
+  /**
+   * The headline for the Billboard. Is styled as an h1 element by default
+   */
+  heading?: string
+  /**
+   * Choose the appropriately semantic tag for the heading
+   */
+  headingAs?: 'h1' | 'h2' | 'h3' | 'span'
+  /**
+   * Choose the font-size for the heading (see the Heading component)
+   */
+  headingLevel?: 'h1' | 'h2' | 'h3' | 'h4'
+  /**
+   * Instructions or information for the Billboard. Note: you should not pass
+   * interactive content to this prop if you are also providing an `href` or
+   * `onClick`. That would cause the Billboard to render as a button or link
+   * and would result in nested interactive content.
+   */
+  message?: Renderable
+  /**
+   * If you add an onClick prop, the Billboard renders as a clickable button
+   */
+  onClick?: (e: MouseEvent<ViewProps>) => void
+  /**
+   * If `href` is provided, Billboard will render as a link
+   */
+  href?: string
+  /**
+   * Whether or not to disable the billboard
+   */
+  disabled?: boolean
+  /**
+   * Works just like disabled but keeps the same styles as if it were active
+   */
+  readOnly?: boolean
+  /**
+   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+   */
+  margin?: Spacing
+}
+
+type PropKeys = keyof BillboardOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type BillboardProps = BillboardOwnProps &
+  WithStyleProps<BillboardTheme, BillboardStyle> &
+  OtherHTMLAttributes<BillboardOwnProps>
+
+type BillboardStyle = ComponentStyle<
+  'billboard' | 'content' | 'hero' | 'heading' | 'message'
+>
+const allowedProps: AllowedPropKeys = [
+  'hero',
+  'size',
+  'as',
+  'elementRef',
+  'heading',
+  'headingAs',
+  'headingLevel',
+  'message',
+  'onClick',
+  'href',
+  'disabled',
+  'readOnly',
+  'margin'
+]
+
+export type { BillboardProps, BillboardStyle, HeroIconSize }
+export { allowedProps }

package/src/Billboard/v2/styles.ts

@@ -0,0 +1,158 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import type { BillboardProps, BillboardStyle } from './props'
+import type { NewComponentTypes } from '@instructure/ui-themes'
+
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} props the props of the component, the style is applied to
+ * @param  {Object} state the state of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+const generateStyle = (
+  componentTheme: NewComponentTypes['Billboard'],
+  props: BillboardProps
+): BillboardStyle => {
+  const { size, href, onClick, disabled, hero, heading } = props
+
+  const clickable = href || onClick
+
+  const sizeVariants = {
+    small: {
+      billboard: { padding: componentTheme.paddingSmall },
+      hero: { fontSize: '3rem' },
+      message: { fontSize: componentTheme.messageFontSizeSmall },
+      heading: { ...(hero && { margin: `${componentTheme.mediumMargin} 0 0` }) }
+    },
+    medium: {
+      billboard: { padding: componentTheme.paddingMedium },
+      hero: { fontSize: '5rem' },
+      message: { fontSize: componentTheme.messageFontSizeMedium },
+      heading: {}
+    },
+    large: {
+      billboard: { padding: componentTheme.paddingLarge },
+      hero: { fontSize: '10rem' },
+      message: { fontSize: componentTheme.messageFontSizeLarge },
+      heading: {}
+    }
+  }
+
+  const clickableVariants = clickable
+    ? {
+        appearance: 'none',
+        boxSizing: 'border-box',
+        cursor: 'pointer',
+        userSelect: 'none',
+        touchAction: 'manipulation',
+        width: '100%',
+        margin: '0',
+        border: `${componentTheme.buttonBorderWidth} ${componentTheme.buttonBorderStyle} transparent`,
+        borderRadius: componentTheme.buttonBorderRadius,
+        background: componentTheme.backgroundColor,
+        textDecoration: 'none',
+
+        '&:hover': { borderStyle: componentTheme.buttonHoverBorderStyle },
+
+        '&:hover, &:focus': {
+          textDecoration: 'none',
+          outline: 'none',
+          borderColor: componentTheme.messageColorClickable
+        },
+        '&:active': {
+          background: componentTheme.clickableActiveBg,
+          borderColor: componentTheme.messageColorClickable,
+
+          '& [class$=-billboard__hero], & [class$=-billboard__message]': {
+            color: componentTheme.clickableActiveText
+          }
+        }
+      }
+    : {
+        backgroundColor: componentTheme.backgroundColor
+      }
+
+  return {
+    billboard: {
+      label: 'billboard',
+      boxSizing: 'border-box',
+      position: 'relative',
+      fontFamily: componentTheme.fontFamily,
+      marginLeft: 'auto',
+      marginRight: 'auto',
+      textAlign: 'center',
+      display: 'block',
+      ...sizeVariants[size!].billboard,
+      ...clickableVariants,
+
+      ...(disabled && {
+        cursor: 'not-allowed',
+        pointerEvents: 'none',
+        opacity: 0.5
+      })
+    },
+    content: {
+      label: 'billboard__content',
+      display: 'block'
+    },
+    hero: {
+      label: 'billboard__hero',
+      display: 'block',
+      ...sizeVariants[size!].hero,
+
+      '& > img, & > svg': {
+        maxWidth: '100%',
+        display: 'block',
+        margin: '0 auto'
+      },
+
+      '& > img': { height: 'auto' }
+    },
+    heading: {
+      label: 'billboard__heading',
+      display: 'block',
+      ...(hero && { margin: `${componentTheme.largeMargin} 0 0` }),
+      ...sizeVariants[size!].heading
+    },
+    message: {
+      label: 'billboard__message',
+      display: 'block',
+      color: clickable
+        ? componentTheme.messageColorClickable
+        : componentTheme.messageColor,
+
+      ...((hero || heading) && {
+        margin: `${componentTheme.mediumMargin} 0 0`
+      }),
+      ...sizeVariants[size!].message
+    }
+  }
+}
+
+export default generateStyle

package/src/exports/a.ts

@@ -0,0 +1,25 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+export { Billboard } from '../Billboard/v1'
+export type { BillboardProps } from '../Billboard/v1/props'

package/src/exports/b.ts

@@ -0,0 +1,25 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+export { Billboard } from '../Billboard/v2'
+export type { BillboardProps } from '../Billboard/v2/props'