@telus-uds/components-base 4.0.0-alpha.2 → 4.0.0-beta.0

package/types/HorizontalScrollButton.d.ts

@@ -1,4 +1,6 @@
-export interface HorizontalScrollButtonTokens {
+import type { ComponentType } from 'react'
+
+export type HorizontalScrollButtonTokens = {
   backgroundColor?: string
   borderColor?: string
   borderRadius?: number | string
@@ -14,3 +16,17 @@ export interface HorizontalScrollButtonTokens {
   padding?: number | string
   shadow?: string
 }
+
+export interface HorizontalScrollButtonProps {
+  direction: 'previous' | 'next'
+  onPress: () => void
+  icon?: ComponentType<any>
+  offset?: number
+  copy?: 'en' | 'fr'
+  variant?: Record<string, string | number | boolean | undefined>
+  tokens?: HorizontalScrollButtonTokens
+}
+
+declare const HorizontalScrollButton: ComponentType<HorizontalScrollButtonProps>
+
+export { HorizontalScrollButton }

package/types/Icon.d.ts

@@ -1,8 +1,15 @@
+import type { ComponentType } from 'react'
+import { StyleProp, ViewStyle } from 'react-native'
+
 export interface IconProps {
   scalesWithText?: boolean
   variant?: IconVariant
   tokens?: IconTokens
-  icon: React.ReactNode
+  icon: ComponentType<any>
+  accessibilityLabel?: string
+  style?: StyleProp<ViewStyle>
+  testID?: string
+  dataSet?: Record<string, any>
 }
 
 export interface IconTokens {
@@ -18,4 +25,8 @@ export type IconVariant = {
   size?: 'micro' | 'small' | 'large' | 'extraLarge'
 }
 
-export type IconPositionLeftRight = 'left' | 'right'
+export type IconPositionLeftRight = 'left' | 'right' | 'inline'
+
+declare const Icon: ComponentType<IconProps>
+
+export { Icon }

package/types/IconButton.d.ts

@@ -0,0 +1,19 @@
+import type { ComponentType, ElementType } from 'react'
+
+export interface IconButtonProps {
+  icon?: ElementType
+  href?: string
+  hrefAttrs?: Record<string, string>
+  onPress?: () => void
+  inactive?: boolean
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+  accessibilityLabel?: string
+  accessibilityRole?: string
+}
+
+declare const IconButton: ComponentType<IconButtonProps>
+
+export { IconButton }

package/types/InputLabel.d.ts

@@ -0,0 +1,12 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface InputLabelProps {
+  children?: ReactNode
+  forId?: string
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const InputLabel: ComponentType<InputLabelProps>
+
+export { InputLabel }

package/types/InputSupports.d.ts

@@ -0,0 +1,19 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface InputSupportsProps {
+  children?: ReactNode | ((props: Record<string, any>) => ReactNode)
+  copy?: 'en' | 'fr'
+  label?: string
+  hint?: string
+  hintPosition?: 'inline' | 'below'
+  validation?: 'error' | 'success'
+  feedback?: string
+  tooltip?: string | Record<string, any>
+  tokens?: Record<string, string | number | boolean | object>
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const InputSupports: ComponentType<InputSupportsProps>
+
+export { InputSupports }

package/types/Link.d.ts

@@ -1,17 +1,29 @@
+import type { ComponentType, ReactNode } from 'react'
 import { IconPositionLeftRight, IconProps } from './Icon'
 
 export interface LinkProps {
-  href: string
-  onPress: () => void
+  href?: string
+  onPress?: () => void
   tokens?: LinkTokens
   accessibilityRole?: string
   accessibilityLabel?: string
   variant?: LinkAndTextButtonVariants
   iconProps?: IconProps
-  icon?: React.ReactNode
+  icon?: ComponentType<any>
   iconPosition?: IconPositionLeftRight
   testID?: string
-  children?: React.ReactNode
+  children?: ReactNode
+  hrefAttrs?: HrefAttrs
+  pointerEvents?: 'all' | 'none' | 'box-only' | 'box-none'
+  onLayout?: (event: any) => void
+  nativeID?: string
+  dataSet?: Record<string, any>
+}
+
+export interface HrefAttrs {
+  download?: string
+  rel?: string
+  target?: string
 }
 
 export enum LinkSize {
@@ -45,3 +57,7 @@ export type LinkTokens = {
   iconTranslateY?: number
   alignSelf?: string
 }
+
+declare const Link: ComponentType<LinkProps>
+
+export { Link }

package/types/List.d.ts

@@ -1,12 +1,12 @@
-import { TextAlign } from '@telus-uds/components-web/types/common'
-import { ReactElement, ReactNode } from 'react'
+import type { ComponentType, ReactElement, ReactNode } from 'react'
+import { TextAlign } from './Common'
 
-type ListVariants = {
+export type ListVariants = {
   size?: 'small' | 'medium' | 'large'
   compact?: boolean
 }
 
-type ListTokens = {
+export type ListTokens = {
   interItemMargin?: number
   interItemMarginWithDivider?: number
   dividerColor?: string
@@ -35,6 +35,7 @@ export interface ListItemProps {
   icon?: ReactNode | string
   iconColor?: string
   iconSize?: number
+  iconVerticalAlign?: 'top' | 'center' | 'bottom'
   title?: string
   testID?: string
 }
@@ -46,3 +47,9 @@ export interface ListItemTokens {
   itemLineHeight?: number
   itemFontName?: string
 }
+
+declare const List: ComponentType<ListProps> & {
+  Item: ComponentType<ListItemProps>
+}
+
+export { List }

package/types/Listbox.d.ts

@@ -1,4 +1,6 @@
-type ListboxTokens = {
+import type { ComponentType, ElementType } from 'react'
+
+export type ListboxTokens = {
   groupBorderRadius?: number | string
   groupBorderWidth?: number | string
   groupFontSize?: number
@@ -65,7 +67,7 @@ type ListboxTokens = {
   secondLevelParentIcon?: string
 }
 
-type ListboxItems = {
+export type ListboxItems = {
   label: string
   href: string
   tokens?: ListboxTokens
@@ -75,10 +77,18 @@ export interface ListboxProps {
   items: ListboxItems[]
   firstItemRef?: object
   parentRef?: object
-  LinkRouter?: React.ElementType
+  LinkRouter?: ElementType
   linkRouterProps?: object
   tokens?: ListboxTokens
   variant?: { secondLevel?: boolean }
   selectedId?: string
   onClose?: () => void
+  copy?: 'en' | 'fr'
+  dictionary?: Record<string, any>
+  testID?: string
+  itemRouterProps?: object
 }
+
+declare const Listbox: ComponentType<ListboxProps>
+
+export { Listbox }

package/types/Modal.d.ts

@@ -0,0 +1,25 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface ModalProps {
+  children?: ReactNode
+  copy?: 'en' | 'fr'
+  isOpen?: boolean
+  onClose?: () => void
+  maxWidth?: boolean
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  closeButton?: ReactNode | null
+  heading?: string
+  headingLevel?: 'h3' | 'h4'
+  subHeading?: string
+  subHeadingSize?: 'small' | 'medium' | 'large'
+  bodyText?: string
+  confirmButtonText?: string
+  testID?: string
+  dataSet?: Record<string, any>
+  accessibilityLabel?: string
+}
+
+declare const Modal: ComponentType<ModalProps>
+
+export { Modal }

package/types/MultiSelectFilter.d.ts

@@ -0,0 +1,24 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface MultiSelectFilterItem {
+  id?: string
+  label: string
+  [key: string]: any
+}
+
+export interface MultiSelectFilterProps {
+  label: string
+  subtitle?: string | ReactNode
+  id?: string
+  variant?: Record<string, string | number | boolean | undefined>
+  tokens?: Record<string, string | number | boolean | object>
+  items?: MultiSelectFilterItem[]
+  onChange?: (selectedIds: string[]) => void
+  selectedIds?: string[]
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const MultiSelectFilter: ComponentType<MultiSelectFilterProps>
+
+export { MultiSelectFilter }

package/types/Notification.d.ts

@@ -0,0 +1,19 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface NotificationProps {
+  children?: string | ReactNode | ((props: Record<string, any>) => ReactNode)
+  dismissible?: boolean
+  copy?: 'en' | 'fr' | { dismiss: string }
+  onDismiss?: () => void
+  contentMinWidth?: Record<string, 'max' | 'full'>
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+  accessibilityLabel?: string
+  accessibilityRole?: string
+}
+
+declare const Notification: ComponentType<NotificationProps>
+
+export { Notification }

package/types/OrderedList.d.ts

@@ -0,0 +1,17 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface OrderedListItemProps {
+  children?: ReactNode
+}
+
+export interface OrderedListProps {
+  children: ReactNode
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const OrderedList: ComponentType<OrderedListProps> & {
+  Item: ComponentType<OrderedListItemProps>
+}
+
+export { OrderedList }

package/types/Pagination.d.ts

@@ -0,0 +1,25 @@
+import type { ComponentType, ElementType, ReactNode } from 'react'
+
+export interface PaginationPageButtonProps {
+  children?: ReactNode
+}
+
+export interface PaginationProps {
+  children?: ReactNode
+  copy?: 'en' | 'fr'
+  variant?: Record<string, string | number | boolean | undefined>
+  tokens?: Record<string, string | number | boolean | object>
+  sideButtonVariant?: Record<string, string | number | boolean | undefined>
+  sideButtonTokens?: Record<string, string | number | boolean | object>
+  numberOfPagesBeforeEllipsis?: number
+  LinkRouter?: ElementType
+  linkRouterProps?: Record<string, any>
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const Pagination: ComponentType<PaginationProps> & {
+  PageButton: ComponentType<PaginationPageButtonProps>
+}
+
+export { Pagination }

package/types/Portal.d.ts

@@ -1,5 +1,9 @@
-import { ReactNode } from 'react'
+import type { ComponentType, ReactNode } from 'react'
 
 export interface PortalProps {
   children: ReactNode
 }
+
+declare const Portal: ComponentType<PortalProps>
+
+export { Portal }

package/types/PriceLockup.d.ts

@@ -0,0 +1,28 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface PriceLockupProps {
+  size?: 'small' | 'medium'
+  currencySymbol?: string
+  topText?: string
+  price: string
+  rateText?: string
+  bottomText?: string
+  signDirection?: 'left' | 'right'
+  footnoteLinks?: Array<number | string>
+  strikeThrough?: boolean
+  a11yText?: string
+  onClickFootnote?: (index: number) => void
+  copy?: 'en' | 'fr'
+  dictionary?: Record<string, any>
+  ratePosition?: 'right' | 'bottom'
+  linkPosition?: string
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  children?: ReactNode
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const PriceLockup: ComponentType<PriceLockupProps>
+
+export { PriceLockup }

package/types/ProductCard.d.ts

@@ -0,0 +1,20 @@
+import type { ComponentType } from 'react'
+
+export interface ProductCardImage {
+  src?: string | ReactNode
+  alt?: string
+}
+
+export interface ProductCardProps {
+  image?: ProductCardImage
+  copy?: 'en' | 'fr'
+  dictionary?: Record<string, any>
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const ProductCard: ComponentType<ProductCardProps>
+
+export { ProductCard }

package/types/ProductCardGroup.d.ts

@@ -0,0 +1,21 @@
+import type { ComponentType } from 'react'
+
+export interface ProductCardGroupCardItem {
+  id: string
+  image?: Record<string, any>
+  dictionary?: Record<string, any>
+  [key: string]: any
+}
+
+export interface ProductCardGroupProps {
+  maxSelection?: number
+  productCards: ProductCardGroupCardItem[]
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const ProductCardGroup: ComponentType<ProductCardGroupProps>
+
+export { ProductCardGroup }

package/types/Progress.d.ts

@@ -0,0 +1,22 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface ProgressBarProps {
+  value?: number
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+}
+
+export interface ProgressProps {
+  children: ReactNode
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const Progress: ComponentType<ProgressProps> & {
+  Bar: ComponentType<ProgressBarProps>
+}
+
+export { Progress }

package/types/QuickLinks.d.ts

@@ -0,0 +1,27 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface QuickLinksItemProps {
+  children?: ReactNode
+  href?: string
+  onPress?: () => void
+  icon?: ComponentType<any>
+  tokens?: Record<string, string | number | boolean | object>
+  testID?: string
+}
+
+export interface QuickLinksProps {
+  children?: ReactNode
+  tokens?: Record<string, string | number | boolean | object>
+  cardTokens?: Record<string, string | number | boolean | object>
+  listTokens?: Record<string, string | number | boolean | object>
+  tag?: string
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const QuickLinks: ComponentType<QuickLinksProps> & {
+  Item: ComponentType<QuickLinksItemProps>
+}
+
+export { QuickLinks }

package/types/QuickLinksFeature.d.ts

@@ -0,0 +1,27 @@
+import type { ComponentType, ReactNode, ElementType } from 'react'
+
+export interface QuickLinksFeatureItemProps {
+  children: ReactNode
+  imageAccessibilityLabel: string
+  imageSource: string | ReactNode
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  href?: string
+  onPress?: () => void
+  LinkRouter?: ElementType
+  linkRouterProps?: Record<string, any>
+}
+
+export interface QuickLinksFeatureProps {
+  children?: ReactNode
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+}
+
+declare const QuickLinksFeature: ComponentType<QuickLinksFeatureProps> & {
+  Item: ComponentType<QuickLinksFeatureItemProps>
+}
+
+export { QuickLinksFeature }

package/types/Radio.d.ts

@@ -0,0 +1,22 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface RadioProps {
+  checked?: boolean
+  defaultChecked?: boolean
+  description?: string
+  id?: string
+  inactive?: boolean
+  label?: string | ReactNode
+  name?: string
+  onChange?: (value: any) => void
+  value?: any
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+  accessibilityLabel?: string
+}
+
+declare const Radio: ComponentType<RadioProps>
+
+export { Radio }

package/types/RadioCard.d.ts

@@ -0,0 +1,21 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export interface RadioCardProps {
+  title?: string
+  children?: ReactNode | ((state: Record<string, any>) => ReactNode)
+  checked?: boolean
+  defaultChecked?: boolean
+  description?: string
+  id?: string
+  inactive?: boolean
+  onChange?: (value: any) => void
+  tokens?: Record<string, string | number | boolean | object>
+  variant?: Record<string, string | number | boolean | undefined>
+  testID?: string
+  dataSet?: Record<string, any>
+  accessibilityLabel?: string
+}
+
+declare const RadioCard: ComponentType<RadioCardProps>
+
+export { RadioCard }

package/types/Responsive.d.ts

@@ -0,0 +1,14 @@
+import type { ComponentType, ReactNode } from 'react'
+
+export type ViewportKey = 'xs' | 'sm' | 'md' | 'lg' | 'xl'
+
+export interface ResponsiveProps {
+  min?: 'xs' | 'sm' | 'md' | 'lg' | 'xl'
+  max?: 'sm' | 'md' | 'lg' | 'xl'
+  inheritedStyles?: string[]
+  children: ReactNode
+}
+
+declare const Responsive: ComponentType<ResponsiveProps>
+
+export { Responsive }

package/types/Scroll.d.ts

@@ -61,6 +61,6 @@ export interface ScrollItemProps {
 }
 
 declare const Scroll: ComponentType<ScrollProps>
-export declare const ScrollItem: ComponentType<ScrollItemProps>
+declare const ScrollItem: ComponentType<ScrollItemProps>
 
-export default Scroll
+export { Scroll, ScrollItem }

package/types/Search.d.ts

@@ -1,3 +1,4 @@
+import type { ComponentType } from 'react'
 import { CopyType, Size } from './Common'
 
 export type SearchTokens = {
@@ -20,8 +21,8 @@ export type SearchTokens = {
   lineHeight?: number
   placeholderColor?: string
   buttonsGap?: Size
-  clearButtonIcon?: React.ReactNode
-  submitButtonIcon?: React.ReactNode
+  clearButtonIcon?: any
+  submitButtonIcon?: any
 }
 
 export interface SearchProps {
@@ -35,4 +36,16 @@ export interface SearchProps {
   onClear?: () => void
   onFocus?: () => void
   tokens?: SearchTokens
+  nativeSubmitBtnID?: string
+  searchIconPosition?: 'left' | 'right'
+  pointerEvents?: 'all' | 'none' | 'box-only' | 'box-none'
+  onLayout?: (event: any) => void
+  nativeID?: string
+  dataSet?: Record<string, any>
+  accessibilityLabel?: string
+  accessibilityRole?: string
 }
+
+declare const Search: ComponentType<SearchProps>
+
+export { Search }

package/types/Select.d.ts

@@ -1,4 +1,4 @@
-import React from 'react'
+import type { ComponentType, ReactNode } from 'react'
 import { IconProps } from './Icon'
 
 export type SelectTokens = {
@@ -28,7 +28,7 @@ export type SelectTokens = {
 }
 
 export interface SelectProps {
-  children: string | React.ReactNode
+  children: string | ReactNode
   label: string
   initialValue?: string
   feedback?: string
@@ -44,14 +44,22 @@ export interface SelectProps {
   placeholder?: string
   tokens?: SelectTokens
   testID?: string
+  dataSet?: Record<string, any>
 }
 
 export interface SelectItemProps {
-  children: string | React.ReactNode
+  children: string | ReactNode
   value: string
 }
 
 export interface SelectGroupProps {
-  children: string | React.ReactNode
+  children: string | ReactNode
   label: string
 }
+
+declare const Select: ComponentType<SelectProps> & {
+  Item: ComponentType<SelectItemProps>
+  Group: ComponentType<SelectGroupProps>
+}
+
+export { Select }