@instructure/ui-instructure 11.7.2-snapshot-9 → 11.7.2-snapshot-11

package/src/NutritionFacts/v2/props.ts

@@ -0,0 +1,103 @@
+/*
+ * 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 { ComponentStyle, ThemeOverrideValue } from '@instructure/emotion'
+import type { OtherHTMLAttributes } from '@instructure/shared-types'
+
+type BlockType = {
+  blockTitle: string
+  segmentData: {
+    segmentTitle: string
+    description: string
+    value: string
+    valueDescription?: string
+  }[]
+}
+
+type NutritionFactsOwnProps = {
+  /**
+   * i18n text for the label of the modal
+   */
+  modalLabel: string
+  /**
+   * i18n text for the Nutrition Facts title
+   */
+  title: string
+  /**
+   * i18n text for the feature name that the Nutrition Facts describes
+   */
+  featureName: string
+  /**
+   * i18n text for the "model and data" heading of the Nutrition Facts
+   */
+  data: BlockType[]
+  /**
+   * i18n text for the close button
+   */
+  closeButtonText: string
+  /**
+   * i18n text for the close iconButton
+   */
+  closeIconButtonScreenReaderLabel: string
+  /**
+   * i18n text for the trigger
+   */
+  triggerText: string
+  /**
+   * sets the modal size to 'fullscreen'. Used for small viewports
+   */
+  fullscreen?: boolean
+}
+
+type PropKeys = keyof NutritionFactsOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type NutritionFactsProps = NutritionFactsOwnProps & {
+  themeOverride?: ThemeOverrideValue
+} & OtherHTMLAttributes<NutritionFactsOwnProps>
+
+type NutritionFactsStyle = ComponentStyle<
+  | 'segmentCard'
+  | 'segmentCardExplainerContainer'
+  | 'segmentContainer'
+  | 'blockContainer'
+  | 'body'
+> & {
+  maxWidth?: string
+}
+
+const allowedProps: AllowedPropKeys = [
+  'fullscreen',
+  'modalLabel',
+  'title',
+  'featureName',
+  'data',
+  'closeButtonText',
+  'closeIconButtonScreenReaderLabel',
+  'triggerText'
+]
+
+export type { NutritionFactsProps, NutritionFactsStyle }
+export { allowedProps }

package/src/NutritionFacts/v2/styles.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 { NewComponentTypes, SharedTokens } from '@instructure/ui-themes'
+import type { NutritionFactsProps, NutritionFactsStyle } from './props'
+
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param componentTheme The theme variable object.
+ * @param params Additional parameters to customize the style.
+ * @param sharedTokens Shared token object that stores common values for the theme.
+ * @return The final style object, which will be used in the component
+ */
+const generateStyle = (
+  componentTheme: NewComponentTypes['NutritionFacts'],
+  _params: NutritionFactsProps,
+  _sharedTokens: SharedTokens
+): NutritionFactsStyle => {
+  return {
+    segmentCard: {
+      label: 'nutrition-facts__segment-card',
+      borderStyle: 'solid',
+      borderWidth: componentTheme?.cardBorderWidth,
+      borderColor: componentTheme?.cardBorderColor,
+      borderRadius: componentTheme?.borderRadius,
+      padding: componentTheme?.cardPadding,
+      display: 'flex',
+      flexDirection: 'column'
+    },
+    segmentCardExplainerContainer: {
+      label: 'nutrition-facts__segment-card-explainer-container',
+      marginBottom: componentTheme?.cardExplainerContainerBottomMargin
+    },
+    segmentContainer: {
+      label: 'nutrition-facts__segment-container',
+      display: 'flex',
+      flexDirection: 'column',
+      gap: componentTheme?.cardGap
+    },
+    blockContainer: {
+      label: 'nutrition-facts__block-container',
+      display: 'flex',
+      flexDirection: 'column',
+      gap: componentTheme?.cardGap
+    },
+    body: {
+      label: 'nutrition-facts__body',
+      display: 'flex',
+      flexDirection: 'column',
+      gap: componentTheme?.blockGap,
+      padding: componentTheme?.bodyPadding,
+      boxSizing: 'border-box'
+    }
+  }
+}
+
+export default generateStyle

package/src/exports/b.ts

@@ -21,9 +21,9 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-export { NutritionFacts } from '../NutritionFacts/v1'
-export { DataPermissionLevels } from '../DataPermissionLevels/v1'
+export { NutritionFacts } from '../NutritionFacts/v2'
+export { DataPermissionLevels } from '../DataPermissionLevels/v2'
 export { AiInformation } from '../AiInformation/v2'
-export type { NutritionFactsProps } from '../NutritionFacts/v1/props'
-export type { DataPermissionLevelsProps } from '../DataPermissionLevels/v1/props'
+export type { NutritionFactsProps } from '../NutritionFacts/v2/props'
+export type { DataPermissionLevelsProps } from '../DataPermissionLevels/v2/props'
 export type { AiInformationProps } from '../AiInformation/v2/props'