@xyo-network/react-property 2.23.7

package/src/components/Property.stories.tsx

@@ -0,0 +1,163 @@
+import ReplayIcon from '@mui/icons-material/Replay'
+import { TextField } from '@mui/material'
+import { ComponentMeta, ComponentStory } from '@storybook/react'
+import { FlexCol, FlexRow } from '@xylabs/sdk-react'
+
+import { appThemeDecorator, sampleBlockWithPayloads } from '../.storybook'
+import { Property } from './Property'
+
+const StorybookEntry = {
+  argTypes: {},
+  component: Property,
+  parameters: {
+    docs: {
+      page: null,
+    },
+  },
+  title: 'Properties/Property',
+} as ComponentMeta<typeof Property>
+
+const Template: ComponentStory<typeof Property> = (args) => <Property {...args}></Property>
+
+const TemplateWithCompare: ComponentStory<typeof Property> = (args) => (
+  <FlexCol alignItems="stretch">
+    <FlexRow>
+      <TextField size="small" value="Sample text Field" />
+      <Property {...args} size="small"></Property>
+    </FlexRow>
+    <FlexRow>
+      <Property {...args} size="small"></Property>
+      <Property {...args} size="small"></Property>
+    </FlexRow>
+    <FlexRow>
+      <TextField size="medium" value="Sample text Field" />
+      <Property {...args} size="medium"></Property>
+    </FlexRow>
+    <FlexRow>
+      <Property {...args} size="medium"></Property>
+      <Property {...args} size="medium"></Property>
+    </FlexRow>
+    <FlexRow>
+      <TextField value="Sample text Field" />
+      <Property {...args} size="large"></Property>
+    </FlexRow>
+    <FlexRow>
+      <Property {...args} size="large"></Property>
+      <Property {...args} size="large"></Property>
+    </FlexRow>
+  </FlexCol>
+)
+
+const Default = Template.bind({})
+Default.args = {}
+Default.decorators = [appThemeDecorator]
+
+const WithTitle = Template.bind({})
+WithTitle.args = { title: 'No Data' }
+WithTitle.decorators = [appThemeDecorator]
+
+const WithUndefinedData = Template.bind({})
+WithUndefinedData.args = { title: 'Block Hash' }
+WithUndefinedData.decorators = [appThemeDecorator]
+
+const WithData = Template.bind({})
+WithData.args = { title: 'Block Hash', value: sampleBlockWithPayloads._hash }
+WithData.decorators = [appThemeDecorator]
+
+const WithDataSmall = Template.bind({})
+WithDataSmall.args = { size: 'small', title: 'Block Hash', value: sampleBlockWithPayloads._hash }
+WithDataSmall.decorators = [appThemeDecorator]
+
+const WithDataCompare = TemplateWithCompare.bind({})
+WithDataCompare.args = { tip: 'This is the block hash', title: 'Block Hash', value: sampleBlockWithPayloads._hash }
+WithDataCompare.decorators = [appThemeDecorator]
+
+const WithDataAndBadgeSmall = Template.bind({})
+WithDataAndBadgeSmall.args = { badge: true, size: 'small', tip: 'This is the block hash', title: 'Block Hash', value: sampleBlockWithPayloads._hash }
+WithDataAndBadgeSmall.decorators = [appThemeDecorator]
+
+const WithDataAndBadgeMedium = Template.bind({})
+WithDataAndBadgeMedium.args = { badge: true, size: 'medium', tip: 'This is the block hash', title: 'Block Hash', value: sampleBlockWithPayloads._hash }
+WithDataAndBadgeMedium.decorators = [appThemeDecorator]
+
+const WithDataAndBadgeLarge = Template.bind({})
+WithDataAndBadgeLarge.args = { badge: true, size: 'large', tip: 'This is the block hash', title: 'Block Hash', value: sampleBlockWithPayloads._hash }
+WithDataAndBadgeLarge.decorators = [appThemeDecorator]
+
+const WithTip = Template.bind({})
+WithTip.args = {
+  tip: 'This is the block hash',
+  title: 'Block Hash',
+  value: sampleBlockWithPayloads._hash,
+}
+WithTip.decorators = [appThemeDecorator]
+
+const WithTipAndBadge = Template.bind({})
+WithTipAndBadge.args = {
+  badge: true,
+  tip: 'This is the block hash',
+  title: 'Block Hash',
+  value: sampleBlockWithPayloads._hash,
+}
+WithTipAndBadge.decorators = [appThemeDecorator]
+
+const WithActions = Template.bind({})
+WithActions.args = {
+  actions: [{ name: 'ActionOne' }, { name: 'ActionTwo' }],
+  tip: 'This is the block hash',
+  title: 'Block Hash',
+  value: sampleBlockWithPayloads._hash,
+}
+WithActions.decorators = [appThemeDecorator]
+
+const LargeWithValue = Template.bind({})
+LargeWithValue.args = {
+  badge: true,
+  size: 'large',
+  tip: 'This is the block hash',
+  title: 'Block Hash',
+  value: sampleBlockWithPayloads._hash,
+}
+LargeWithValue.decorators = [appThemeDecorator]
+
+const LargeWithValueAndActions = Template.bind({})
+LargeWithValueAndActions.args = {
+  actions: [{ icon: <ReplayIcon />, name: 'ActionOne' }, { name: 'ActionTwo' }],
+  badge: true,
+  size: 'large',
+  tip: 'This is the block hash',
+  title: 'Block Hash',
+  value: sampleBlockWithPayloads._hash,
+}
+LargeWithValueAndActions.decorators = [appThemeDecorator]
+
+const SmallWithValueAndActions = Template.bind({})
+SmallWithValueAndActions.args = {
+  actions: [{ icon: <ReplayIcon />, name: 'ActionOne' }, { name: 'ActionTwo' }],
+  badge: true,
+  size: 'small',
+  tip: 'This is the block hash',
+  title: 'Block Hash',
+  value: sampleBlockWithPayloads._hash,
+}
+SmallWithValueAndActions.decorators = [appThemeDecorator]
+
+export {
+  Default,
+  LargeWithValue,
+  LargeWithValueAndActions,
+  SmallWithValueAndActions,
+  WithActions,
+  WithData,
+  WithDataAndBadgeLarge,
+  WithDataAndBadgeMedium,
+  WithDataAndBadgeSmall,
+  WithDataCompare,
+  WithDataSmall,
+  WithTip,
+  WithTipAndBadge,
+  WithUndefinedData,
+}
+
+// eslint-disable-next-line import/no-default-export
+export default StorybookEntry

package/src/components/Property.tsx

@@ -0,0 +1,64 @@
+import { CircularProgress, TypographyVariant, useTheme } from '@mui/material'
+import { FlexCol, FlexRow } from '@xylabs/sdk-react'
+
+import { IdenticonCorner } from './IdenticonCorner'
+import { PropertyActionsMenu } from './PropertyActionsMenu'
+import { PropertyProps } from './PropertyProps'
+import { SizeProp } from './SizeProp'
+import { PropertyTitle } from './Title'
+import { PropertyValue } from './Value'
+
+export const Property: React.FC<PropertyProps> = ({ title, value, children, size = 'medium', tip, actions, required, badge = false, ...props }) => {
+  const theme = useTheme()
+
+  const sizeTitleHeight: Record<SizeProp, number> = {
+    large: 36,
+    medium: 20,
+    small: 14,
+  }
+
+  const sizeValueHeight: Record<SizeProp, number> = {
+    large: 64,
+    medium: 36,
+    small: 26,
+  }
+
+  const sizeVariants: Record<SizeProp, TypographyVariant> = {
+    large: 'h6',
+    medium: 'body1',
+    small: 'body1',
+  }
+
+  return (
+    <FlexCol
+      minWidth={0}
+      alignItems="stretch"
+      border={1}
+      borderColor={required && value === undefined ? theme.palette.error.main : theme.palette.divider}
+      borderRadius={1}
+      overflow="hidden"
+      {...props}
+    >
+      {title !== undefined ? (
+        <PropertyTitle
+          tip={tip}
+          title={title}
+          size={size}
+          bgcolor={theme.palette.secondary.main}
+          color={theme.palette.getContrastText(theme.palette.secondary.main)}
+          height={sizeTitleHeight[size]}
+          more={<PropertyActionsMenu actions={actions} />}
+        />
+      ) : null}
+      <FlexRow justifyContent={value === undefined ? 'center' : 'space-between'} overflow="hidden" height={sizeValueHeight[size]}>
+        {children}
+        {value !== undefined ? (
+          <PropertyValue shortSpace={badge ? sizeValueHeight[size] : 0} value={value} typographyVariant={sizeVariants[size]} />
+        ) : (
+          <CircularProgress size={16} />
+        )}
+        {value !== undefined ? badge ? <IdenticonCorner value={value} /> : null : null}
+      </FlexRow>
+    </FlexCol>
+  )
+}

package/src/components/PropertyAction.ts

@@ -0,0 +1,8 @@
+import { ReactNode } from 'react'
+
+export interface PropertyAction {
+  disabled?: boolean
+  name: string
+  icon?: ReactNode
+  onClick?: () => void
+}

package/src/components/PropertyActions.tsx

@@ -0,0 +1,27 @@
+import { IconButton, Stack } from '@mui/material'
+import { ButtonEx, FlexRow } from '@xylabs/sdk-react'
+
+import { PropertyActionsProps } from './PropertyActionsProps'
+
+export const PropertyActions: React.FC<PropertyActionsProps> = ({ buttons = false, actions, ...props }) => {
+  if (actions) {
+    return (actions?.length ?? 0) > 0 ? (
+      <FlexRow {...props}>
+        <Stack direction="row" spacing={1}>
+          {actions.map((action, index) => {
+            return action.icon ? (
+              <IconButton size="small" key={index} color="inherit" onClick={action.onClick}>
+                {action.icon}
+              </IconButton>
+            ) : buttons ? (
+              <ButtonEx paddingY={0} color="primary" key={index} size="small" disabled={action.disabled} onClick={action.onClick} variant="contained">
+                {action.name}
+              </ButtonEx>
+            ) : null
+          })}
+        </Stack>
+      </FlexRow>
+    ) : null
+  }
+  return null
+}

package/src/components/PropertyActionsMenu.tsx

@@ -0,0 +1,41 @@
+import MoreHorizIcon from '@mui/icons-material/MoreHoriz'
+import { IconButton, Menu, MenuItem } from '@mui/material'
+import { FlexRow } from '@xylabs/sdk-react'
+import { useState } from 'react'
+
+import { PropertyActionsProps } from './PropertyActionsProps'
+
+export const PropertyActionsMenu: React.FC<PropertyActionsProps> = ({ actions, ...props }) => {
+  const [anchorEl, setAnchorEl] = useState<null | HTMLElement>(null)
+  const open = !!anchorEl
+
+  const handleClick = (event: React.MouseEvent<HTMLElement>) => {
+    setAnchorEl(event.currentTarget)
+  }
+  const handleClose = () => {
+    setAnchorEl(null)
+  }
+
+  return actions && actions?.length > 0 ? (
+    <FlexRow {...props}>
+      <IconButton size="small" color="inherit" onClick={handleClick}>
+        <MoreHorizIcon fontSize="inherit" />
+      </IconButton>
+      <Menu anchorEl={anchorEl} open={open} onClose={handleClose}>
+        {actions?.map((action) => {
+          return (
+            <MenuItem
+              key={action.name}
+              onClick={() => {
+                action?.onClick?.()
+                handleClose()
+              }}
+            >
+              {action.name}
+            </MenuItem>
+          )
+        })}
+      </Menu>
+    </FlexRow>
+  ) : null
+}

package/src/components/PropertyActionsProps.ts

@@ -0,0 +1,8 @@
+import { FlexBoxProps } from '@xylabs/sdk-react'
+
+import { PropertyAction } from './PropertyAction'
+
+export interface PropertyActionsProps extends FlexBoxProps {
+  buttons?: boolean
+  actions?: PropertyAction[]
+}

package/src/components/PropertyProps.tsx

@@ -0,0 +1,15 @@
+import { FlexBoxProps } from '@xylabs/sdk-react'
+import { ReactNode } from 'react'
+
+import { PropertyAction } from './PropertyAction'
+import { SizeProp } from './SizeProp'
+
+export interface PropertyProps extends FlexBoxProps {
+  actions?: PropertyAction[]
+  required?: boolean
+  tip?: ReactNode
+  title?: string
+  value?: string | number | boolean | null
+  badge?: boolean
+  size?: SizeProp
+}

package/src/components/SizeProp.ts

@@ -0,0 +1 @@
+export type SizeProp = 'small' | 'medium' | 'large'

package/src/components/Title.stories.tsx

@@ -0,0 +1,32 @@
+import { ComponentMeta, ComponentStory } from '@storybook/react'
+
+import { PropertyTitle } from './Title'
+
+const StorybookEntry = {
+  argTypes: {},
+  component: PropertyTitle,
+  parameters: {
+    docs: {
+      page: null,
+    },
+  },
+  title: 'Properties/Title',
+} as ComponentMeta<typeof PropertyTitle>
+
+const Template: ComponentStory<typeof PropertyTitle> = (args) => <PropertyTitle {...args}></PropertyTitle>
+
+const Default = Template.bind({})
+Default.args = {}
+
+const WithData = Template.bind({})
+
+WithData.args = { title: 'Sample Title' }
+
+const WithDataAndActions = Template.bind({})
+
+WithDataAndActions.args = { title: 'Sample Title' }
+
+export { Default, WithData, WithDataAndActions }
+
+// eslint-disable-next-line import/no-default-export
+export default StorybookEntry

package/src/components/Title.tsx

@@ -0,0 +1,38 @@
+import { Typography, TypographyVariant, useTheme } from '@mui/material'
+import { FlexBoxProps, FlexRow, QuickTipButton } from '@xylabs/sdk-react'
+import { ReactNode } from 'react'
+
+import { SizeProp } from './SizeProp'
+
+export interface PropertyTitleProps extends FlexBoxProps {
+  tip?: ReactNode
+  more?: ReactNode
+  title?: string
+  size?: SizeProp
+}
+
+export const PropertyTitle: React.FC<PropertyTitleProps> = ({ size = 'medium', tip, more, title, ...props }) => {
+  const sizeVariants: Record<SizeProp, TypographyVariant> = {
+    large: 'h6',
+    medium: 'caption',
+    small: 'caption',
+  }
+
+  const theme = useTheme()
+
+  return (
+    <FlexRow justifyContent="space-between" {...props}>
+      <FlexRow paddingX={1}>
+        <Typography noWrap variant={sizeVariants[size]}>
+          {title}
+        </Typography>
+        {tip ? (
+          <QuickTipButton style={{ fontSize: theme.typography[sizeVariants[size]].fontSize }} color="inherit" title={title ?? ''}>
+            {tip}
+          </QuickTipButton>
+        ) : null}
+      </FlexRow>
+      {more}
+    </FlexRow>
+  )
+}

package/src/components/Value.stories.tsx

@@ -0,0 +1,29 @@
+import { ComponentMeta, ComponentStory } from '@storybook/react'
+
+import { sampleBlockWithPayloads } from '../.storybook'
+import { PropertyValue } from './Value'
+
+const StorybookEntry = {
+  argTypes: {},
+  component: PropertyValue,
+  parameters: {
+    docs: {
+      page: null,
+    },
+  },
+  title: 'Properties/Value',
+} as ComponentMeta<typeof PropertyValue>
+
+const Template: ComponentStory<typeof PropertyValue> = (args) => <PropertyValue {...args}></PropertyValue>
+
+const Default = Template.bind({})
+Default.args = {}
+
+const WithData = Template.bind({})
+
+WithData.args = { value: sampleBlockWithPayloads._hash }
+
+export { Default, WithData }
+
+// eslint-disable-next-line import/no-default-export
+export default StorybookEntry

package/src/components/Value.tsx

@@ -0,0 +1,55 @@
+import { Typography, TypographyProps, useTheme } from '@mui/material'
+import { Variant } from '@mui/material/styles/createTypography'
+import { useEffect, useRef, useState } from 'react'
+
+export interface PropertyValueProps extends TypographyProps<'div'> {
+  value?: string | number | boolean | null
+  typographyVariant?: Variant
+  /** @field The space that is removed from the ... at end (mainly for identicon) */
+  shortSpace?: number
+}
+
+export const PropertyValue: React.FC<PropertyValueProps> = ({ value, shortSpace, typographyVariant = 'caption', ...props }) => {
+  const [parentWidth, setParentWidth] = useState<number>()
+  const theme = useTheme()
+
+  const ref = useRef<HTMLDivElement>(null)
+
+  const customThemeProps = {
+    clamped: parentWidth && theme ? parentWidth - parseInt(theme.spacing(2), 10) - (shortSpace ?? 0) : undefined,
+    title: value?.toString(),
+  }
+
+  useEffect(() => {
+    const resizeHandler = () => {
+      const smallestWidth = getSmallestParentWidth(ref.current)
+      setParentWidth(smallestWidth)
+    }
+
+    const getSmallestParentWidth = (element: HTMLElement | null) => {
+      let current = element?.parentElement
+      let width: number | null = null
+      while (current) {
+        if (width === null || current.clientWidth < width) {
+          width = current.clientWidth
+        }
+        current = current.parentElement
+      }
+      return width ?? undefined
+    }
+
+    window.addEventListener('resize', resizeHandler)
+
+    setParentWidth(getSmallestParentWidth(ref.current))
+
+    return () => {
+      window?.removeEventListener('resize', resizeHandler)
+    }
+  }, [])
+
+  return value !== undefined ? (
+    <Typography minWidth={0} marginX={1} ref={ref} component="div" variant={typographyVariant} fontFamily="monospace" fontWeight="light" {...customThemeProps} {...props}>
+      {value}
+    </Typography>
+  ) : null
+}

package/src/components/index.ts

@@ -0,0 +1,6 @@
+export * from './Property'
+export * from './PropertyAction'
+export * from './PropertyProps'
+export * from './SizeProp'
+export * from './usePropertyHeroProps'
+export * from './Value'

package/src/components/usePropertyHeroProps.tsx

@@ -0,0 +1,12 @@
+// Any is ok since we are destructuring props of any shape
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const usePropertyHeroProps = (props: Record<any, any>) => {
+  const { isHero, paddingFactor, showBadge } = props
+  return {
+    isHero,
+    paddingFactor,
+    showBadge,
+  }
+}
+
+export { usePropertyHeroProps }

package/src/index.ts

@@ -0,0 +1 @@
+export * from './components'