Skip to content

chore(Message): use React.forwardRef() #4251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 74 additions & 75 deletions src/collections/Message/Message.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import cx from 'clsx'
import _ from 'lodash'
import PropTypes from 'prop-types'
import React, { Component } from 'react'
import React from 'react'

import {
childrenUtils,
Expand All @@ -12,6 +12,7 @@ import {
SUI,
useKeyOnly,
useKeyOrValueAndKey,
useEventCallback,
} from '../../lib'
import Icon from '../../elements/Icon'
import MessageContent from './MessageContent'
Expand All @@ -23,86 +24,82 @@ import MessageItem from './MessageItem'
* A message displays information that explains nearby content.
* @see Form
*/
export default class Message extends Component {
handleDismiss = (e) => {
const { onDismiss } = this.props

if (onDismiss) onDismiss(e, this.props)
}

render() {
const {
attached,
children,
className,
color,
compact,
content,
error,
floating,
header,
hidden,
icon,
info,
list,
negative,
onDismiss,
positive,
size,
success,
visible,
warning,
} = this.props

const classes = cx(
'ui',
color,
size,
useKeyOnly(compact, 'compact'),
useKeyOnly(error, 'error'),
useKeyOnly(floating, 'floating'),
useKeyOnly(hidden, 'hidden'),
useKeyOnly(icon, 'icon'),
useKeyOnly(info, 'info'),
useKeyOnly(negative, 'negative'),
useKeyOnly(positive, 'positive'),
useKeyOnly(success, 'success'),
useKeyOnly(visible, 'visible'),
useKeyOnly(warning, 'warning'),
useKeyOrValueAndKey(attached, 'attached'),
'message',
className,
)

const dismissIcon = onDismiss && <Icon name='close' onClick={this.handleDismiss} />
const rest = getUnhandledProps(Message, this.props)
const ElementType = getElementType(Message, this.props)

if (!childrenUtils.isNil(children)) {
return (
<ElementType {...rest} className={classes}>
{dismissIcon}
{children}
</ElementType>
)
}

const Message = React.forwardRef(function (props, ref) {
const {
attached,
children,
className,
color,
compact,
content,
error,
floating,
header,
hidden,
icon,
info,
list,
negative,
onDismiss,
positive,
size,
success,
visible,
warning,
} = props

const classes = cx(
'ui',
color,
size,
useKeyOnly(compact, 'compact'),
useKeyOnly(error, 'error'),
useKeyOnly(floating, 'floating'),
useKeyOnly(hidden, 'hidden'),
useKeyOnly(icon, 'icon'),
useKeyOnly(info, 'info'),
useKeyOnly(negative, 'negative'),
useKeyOnly(positive, 'positive'),
useKeyOnly(success, 'success'),
useKeyOnly(visible, 'visible'),
useKeyOnly(warning, 'warning'),
useKeyOrValueAndKey(attached, 'attached'),
'message',
className,
)
const rest = getUnhandledProps(Message, props)
const ElementType = getElementType(Message, props)

const handleDismiss = useEventCallback((e) => {
_.invoke(props, 'onDismiss', e, props)
})
const dismissIcon = onDismiss && <Icon name='close' onClick={handleDismiss} />

if (!childrenUtils.isNil(children)) {
return (
<ElementType {...rest} className={classes}>
<ElementType {...rest} className={classes} ref={ref}>
{dismissIcon}
{Icon.create(icon, { autoGenerateKey: false })}
{(!_.isNil(header) || !_.isNil(content) || !_.isNil(list)) && (
<MessageContent>
{MessageHeader.create(header, { autoGenerateKey: false })}
{MessageList.create(list, { autoGenerateKey: false })}
{createHTMLParagraph(content, { autoGenerateKey: false })}
</MessageContent>
)}
{children}
</ElementType>
)
}
}

return (
<ElementType {...rest} className={classes} ref={ref}>
{dismissIcon}
{Icon.create(icon, { autoGenerateKey: false })}
{(!_.isNil(header) || !_.isNil(content) || !_.isNil(list)) && (
<MessageContent>
{MessageHeader.create(header, { autoGenerateKey: false })}
{MessageList.create(list, { autoGenerateKey: false })}
{createHTMLParagraph(content, { autoGenerateKey: false })}
</MessageContent>
)}
</ElementType>
)
})

Message.displayName = 'Message'
Message.propTypes = {
/** An element type to render as (string or function). */
as: PropTypes.elementType,
Expand Down Expand Up @@ -178,3 +175,5 @@ Message.Content = MessageContent
Message.Header = MessageHeader
Message.List = MessageList
Message.Item = MessageItem

export default Message
7 changes: 4 additions & 3 deletions src/collections/Message/MessageContent.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,20 @@ import { childrenUtils, customPropTypes, getElementType, getUnhandledProps } fro
/**
* A message can contain a content.
*/
function MessageContent(props) {
const MessageContent = React.forwardRef(function (props, ref) {
const { children, className, content } = props
const classes = cx('content', className)
const rest = getUnhandledProps(MessageContent, props)
const ElementType = getElementType(MessageContent, props)

return (
<ElementType {...rest} className={classes}>
<ElementType {...rest} className={classes} ref={ref}>
{childrenUtils.isNil(children) ? content : children}
</ElementType>
)
}
})

MessageContent.displayName = 'MessageContent'
MessageContent.propTypes = {
/** An element type to render as (string or function). */
as: PropTypes.elementType,
Expand Down
8 changes: 5 additions & 3 deletions src/collections/Message/MessageHeader.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,21 @@ import {
/**
* A message can contain a header.
*/
function MessageHeader(props) {
const MessageHeader = React.forwardRef(function (props, ref) {
const { children, className, content } = props

const classes = cx('header', className)
const rest = getUnhandledProps(MessageHeader, props)
const ElementType = getElementType(MessageHeader, props)

return (
<ElementType {...rest} className={classes}>
<ElementType {...rest} className={classes} ref={ref}>
{childrenUtils.isNil(children) ? content : children}
</ElementType>
)
}
})

MessageHeader.displayName = 'MessageHeader'
MessageHeader.propTypes = {
/** An element type to render as (string or function). */
as: PropTypes.elementType,
Expand Down
8 changes: 5 additions & 3 deletions src/collections/Message/MessageItem.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,21 @@ import {
/**
* A message list can contain an item.
*/
function MessageItem(props) {
const MessageItem = React.forwardRef(function (props, ref) {
const { children, className, content } = props

const classes = cx('content', className)
const rest = getUnhandledProps(MessageItem, props)
const ElementType = getElementType(MessageItem, props)

return (
<ElementType {...rest} className={classes}>
<ElementType {...rest} className={classes} ref={ref}>
{childrenUtils.isNil(children) ? content : children}
</ElementType>
)
}
})

MessageItem.displayName = 'MessageItem'
MessageItem.propTypes = {
/** An element type to render as (string or function). */
as: PropTypes.elementType,
Expand Down
8 changes: 5 additions & 3 deletions src/collections/Message/MessageList.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,21 @@ import MessageItem from './MessageItem'
/**
* A message can contain a list of items.
*/
function MessageList(props) {
const MessageList = React.forwardRef(function (props, ref) {
const { children, className, items } = props

const classes = cx('list', className)
const rest = getUnhandledProps(MessageList, props)
const ElementType = getElementType(MessageList, props)

return (
<ElementType {...rest} className={classes}>
<ElementType {...rest} className={classes} ref={ref}>
{childrenUtils.isNil(children) ? _.map(items, MessageItem.create) : children}
</ElementType>
)
}
})

MessageList.displayName = 'MessageList'
MessageList.propTypes = {
/** An element type to render as (string or function). */
as: PropTypes.elementType,
Expand Down
2 changes: 2 additions & 0 deletions test/specs/collections/Message/Message-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import { sandbox } from 'test/utils'

describe('Message', () => {
common.isConformant(Message)
common.forwardsRef(Message)
common.forwardsRef(Message, { requiredProps: { children: <span /> } })
common.hasSubcomponents(Message, [MessageContent, MessageHeader, MessageList])
common.hasUIClassName(Message)
common.rendersChildren(Message, {
Expand Down
1 change: 1 addition & 0 deletions test/specs/collections/Message/MessageContent-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import * as common from 'test/specs/commonTests'

describe('MessageContent', () => {
common.isConformant(MessageContent)
common.forwardsRef(MessageContent)
common.rendersChildren(MessageContent)

it('renders an div tag', () => {
Expand Down
1 change: 1 addition & 0 deletions test/specs/collections/Message/MessageHeader-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import * as common from 'test/specs/commonTests'

describe('MessageHeader', () => {
common.isConformant(MessageHeader)
common.forwardsRef(MessageHeader)
common.implementsCreateMethod(MessageHeader)
common.rendersChildren(MessageHeader)

Expand Down
1 change: 1 addition & 0 deletions test/specs/collections/Message/MessageItem-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import * as common from 'test/specs/commonTests'

describe('MessageItem', () => {
common.isConformant(MessageItem)
common.forwardsRef(MessageItem, { tagName: 'li' })
common.implementsCreateMethod(MessageItem)
common.rendersChildren(MessageItem)

Expand Down
1 change: 1 addition & 0 deletions test/specs/collections/Message/MessageList-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import * as common from 'test/specs/commonTests'

describe('MessageList', () => {
common.isConformant(MessageList)
common.forwardsRef(MessageList, { tagName: 'ul' })
common.implementsCreateMethod(MessageList)
common.rendersChildren(MessageList, {
rendersContent: false,
Expand Down