Semantic-ui-react: RFC: `transition` and `popup` common shorthand

[jeffcarbs]

Background

I've been using <Popup> in my app for tooltips and it's a little cumbersome to use. Here's an example usage for showing a popup on a disabled button (note: this doesn't actually work out of the box since pointer-events are disabled on buttons 😐 )

const buttonElement = (
  <Button
    content='Some action!'
    disabled={disabled}
    loading={loading}
    onClick={onClick}
    primary
  />
)

if (!disabled) {
  return buttonElement
}

return (
  <Popup
    content='This button is disabled!'
    trigger={buttonElement}
  />
)

Proposal

What if we were to add a popup common shorthand prop to all components. The same example from above could be written as:

<Button
  content='Some action!'
  disabled={disabled}
  loading={loading}
  onClick={onClick}
  popup={disabled && 'This button is disabled!'}
  primary
/>

Under the hood, it would use a Popup.create shorthand factory:

Popup.create(props.popup, { trigger: /*regularly rendered button*/ })

// In this case would render
<Popup content='This button is disabled!' trigger={<Button>Some action</Button>} />

Transition

The Transition component (currently underway in #813) strikes me as something that will have the same cumbersome usage.

<Transition animation='slide'><Button /></Transition>

could be written as

<Button transition='slide' />

To me the former reads like "render a transition that results in a button", whereas the latter reads more naturally: "render a button with the slide transition".

Both the transition and popup props would be shorthand so they could be customized even further. For example:

<Button popup={{ inverted: true, on: 'click', content: 'Clicked!' }} />

Implementation

I think it would be crazy to try to do this with our components as-is given that we'd have to touch every single file. I really think we need to solve #419 first and get all of our components rendering via some common method. Whether it's a render method utility, a base component that every component eventually renders down to, or some factory.

cc @layershifter @levithomason - would love your thoughts!

[levithomason]

Man, I love your proposals :) Yes, a popup prop has been on mind since day one. I also think we should solve the base component idea before doing this.

I hadn't considered transition, but it also makes perfect sense to me. This gets me thinking that the Dropdown menu could also take advantage of this pattern, using trigger. Really, any component wraps or appears beside another component could / should be added as a prop IMO.

Imagine:

<Dropdown trigger={<Image avatar src='...' />} options={options} />

// vs

<Image avatar src='...' dropdown={options} />

Not only is a single import needed, but it seems like it follows the more natural logical progression "I want to add a Popup/Dropdown to an Image" rather than "I want to wrap an Image in a Popup/Dropdown".

[levithomason]

I've removed this from the 1.0 requirement, still think we should do this, just not as a blocking item.

[padrefuture]

Im looking into building a menu with an animated transition. Was thinking of using popup with a transition but it doesnt seem to work. Any ideas?

[layershifter]

Transitions aren't supported by components yet. We're working on it, no ETA.

[padrefuture]

This site: http://stoplight.io/platform/design/
was listed as an example site...is this not built in React / Semantic UI?
I suppose i will build the menu without in hopes of adding later. Only other option is to use something other than react?

[levithomason]

@padrefuture Note that most landing pages are not built with React. React is best suited for apps. Stoplight still appears to use SUIR in their apps:

https://app.stoplight.io
https://next.stoplight.io

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 30 days if no further activity occurs. Thank you for your contributions.

[levithomason]

Thanks to @rijk, we have improved how we handle stale issues, see #2761. Reopening.

[pferreir]

Any news on this? Any way I could help?

[stale[bot]]

There has been no activity in this thread for 180 days. While we care about every issue and we’d love to see this fixed, the core team’s time is limited so we have to focus our attention on the issues that are most pressing. Therefore, we will likely not be able to get to this one.

However, PRs for this issue will of course be accepted and welcome!

If there is no more activity in the next 180 days, this issue will be closed automatically for housekeeping. To prevent this, simply leave a reply here. Thanks!

[stale[bot]]

This issue will be closed due to lack of activity for 12 months. If you’d like this to be reopened, just leave a comment; we do monitor them!