Skip to content
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

feat(step): new variant to support the steps with circular railing #2917

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

ko2in
Copy link
Member

@ko2in ko2in commented Sep 28, 2023

Description

This PR add the new variant railing to the steps which suppose to display the steps with circular railing horizontally or vertically.

I used the name raliing since we already have rail component which can conflict each other. If you have better name for this variant, please suggest.

Testcase

https://jsfiddle.net/ko2in/n9dum7fg/

Screenshot (if possible)

fui-railing-step

Closes

#2170

@ko2in
Copy link
Member Author

ko2in commented Sep 28, 2023

I had to fix stylelint errors and rebase to take out this commit, and done forced push. Would it be OK?

@lubber-de
Copy link
Member

Great! But why dont we just name it circular as we already have for image, icon, label and button?

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inner circle isnt centered, looks misplaced

image

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inverted variant is not properly supported
image

Using any other background than white would need to change the non completed icon background as well. I know you set white as background to cover the connection line (i had a similar issue for connected feed)
image

@lubber-de lubber-de added type/feat Any feature requests or improvements lang/css Anything involving CSS labels Sep 28, 2023
@ko2in
Copy link
Member Author

ko2in commented Sep 28, 2023

I didn't implement for inverted yet. I don't know how the inverted should be at the moment.

@lubber-de
Copy link
Member

The connection line cover background could be avoided by

.ui.railing.vertical.steps .step:not(:last-child) .content::before {
margin-top: 2.2em;
}

it seems....

I wonder why i had so many issues doing that for connected feed... perhaps more difficult markup, Will take a look for that again

@ko2in
Copy link
Member Author

ko2in commented Sep 28, 2023

Great! But why dont we just name it circular as we already have for image, icon, label and button?

That sound also OK for me. I will update the PR with that name and other fixes.

@lubber-de
Copy link
Member

lubber-de commented Sep 28, 2023

I didn't implement for inverted yet. I don't know how the inverted should be at the moment.

Not much to be done i believe. I suggest to:

  • use dedicated less variables (yes, even if those would have the same value) for the inverted variant
  • increase specificity, so the normal inverted variant does not override the railing ones (would already fix the inner circle color from black to green)
  • dont use white as background (perhaps no background at all/transparent in case my margin-top idea works for you would already fix that)
  • use a light color for the connection lines
  • use the default inverted green colors

@jamessampford
Copy link
Contributor

Nice! Would it be possible to have an option to have a title and/or description on the horizontal variant below the step circles?

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ordered variant is totally messed up unfortunately

image

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The size variants need adjustments at least for vertical variant

tiny steps

  • check icon too low, but circle icon for uncompleted looks good now :D
    image

massive steps

  • both icons misplaced
  • text for content title and description needs some padding (this is also the case for the normal step without your new variant, i just stumbled upon that)
    image

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link step variant isn't supported

image

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new variant seems to be always unstackable. This could be a design choice and perhaps supported later if a visually pleasing solution can be found

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my final comment/suggestion: 😉

disabled step does not have any visual effect (you removed that on purpose...why?)

We should support color names like we have for the connected feed variant.
Currently the green color is hardcoded (@completedColor). The green was supposed to work for the usual step variant where coloring would not make so much sense to me as it would only have effect on the check icon.

But as your new variant concentrates on the icon and connection line there is a possible need for a different color (maybe only for a single completed step) and screams for being colorizable via a color class name.

Support coloring as we have it elsewhere would support

  • ui purple circular steps
  • blue completed step
  • teal step
  • The connection line should inherit the color as we have it in connected feed

@ko2in
Copy link
Member Author

ko2in commented Sep 28, 2023

disabled step does not have any visual effect (you removed that on purpose...why?)

I don't see any difference style for disabled step like box item. Maybe, remove the small circle disc?

@lubber-de
Copy link
Member

lubber-de commented Sep 28, 2023

disabled step does not have any visual effect (you removed that on purpose...why?)

I don't see any difference style for disabled step like box item. Maybe, remove the small circle disc?

A disabled variant almost always has

  • a lower opacity value
    image

  • greyed out (if lower opacity doesn't make it visually clear already (IMHO not necessary when doing the example given above)

  • pointer-events: none (already implemented)

@ko2in
Copy link
Member Author

ko2in commented Sep 28, 2023

Disabled state would OK with completed or active. The default state already looks similar to the disabled item as it's color and background is grayed out.

@ko2in
Copy link
Member Author

ko2in commented Sep 28, 2023

If this looks OK for you, then I'll apply also the opacity for the default state.
rail-step-opacity

@lubber-de
Copy link
Member

the opacity can be applied to either normal state or completed state. But you should still see the default (non-disabled, non completed) state greyed out (if no color is given as suggested above) and opacity:1 (it gets more clear when text is used in the vertical variant

If you meant the same, then: yes 😄

image

@ko2in
Copy link
Member Author

ko2in commented Oct 7, 2023

@lubber-de Here we go! I've finished the implementation with the other variantions and all your suggestions.

Due to the nature and design approaches, the circular step doesn't have the following variations: stackable, unstackable, attached and evenly divided.

I'm not sure what is going on with jsfiddle.net. It seems to be stopped working for me since yesterday. I cannot browse the website anymore.

So, I've created the examples and demonstrations in CodeSandbox.

@jamessampford
Copy link
Contributor

Looking good 😊

The only bit I’m unsure about is the coloured line appearing after the active step, I think it should only go backwards to the previous step (so between completed and active)

Possibly should have an option not to change the header colour as well on the horizontal version (or possibly if by adding .active to the header it inherits the same colour?)

Any possibility of having header supported below the horizontal version?

Not sure if possible at all, but could even be pretty cool to have an optional pulsating active version (of the circle, could possibly have the line between active and last completed pulsating as well separately but certainly the active circle by itself)

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏🏼 This is already very awesome. Your example code is also a good candidate for later docs 😉
Please see my comments again

src/definitions/elements/step.less Outdated Show resolved Hide resolved
src/themes/default/elements/step.variables Outdated Show resolved Hide resolved
src/themes/default/elements/step.variables Outdated Show resolved Hide resolved
src/themes/default/elements/step.variables Outdated Show resolved Hide resolved
src/themes/default/elements/step.variables Outdated Show resolved Hide resolved
src/definitions/elements/step.less Outdated Show resolved Hide resolved
src/themes/default/elements/step.variables Outdated Show resolved Hide resolved
src/definitions/elements/step.less Show resolved Hide resolved
@ko2in
Copy link
Member Author

ko2in commented Oct 8, 2023

The only bit I’m unsure about is the coloured line appearing after the active step, I think it should only go backwards to the previous step (so between completed and active)

@jamessampford Yeah! That would be better I guess. What do you think @lubber-de ?

@lubber-de
Copy link
Member

Yes, agree

@ko2in
Copy link
Member Author

ko2in commented Oct 9, 2023

Now, the color rule for the rail line is changed as suggested by @jamessampford.

The line only after the completed step is now showing the particular color. The rest of the states would use the default color for the rail line.

Jsfiddle: https://jsfiddle.net/ko2in/86spora2/ https://jsfiddle.net/lubber/t1j7yxoz/
CodeSandbox: https://codesandbox.io/s/fui-circular-step-hqc7k7?file=/index.html

@jamessampford
Copy link
Contributor

I’ve managed to add optional pulsating to active - https://codesandbox.io/s/fui-circular-step-forked-7tqhs6?file=/index.html - probably needs some tweaking … borrowed from transitions, though needs to target the ::before - I did try ::after as well, but think the former looks better on its own instead of the latter or both

The new variant circular step shows a series of steps with the
circular marker and connection line between them.

It supports the three layout styles: horizontal, vertical and
ordered.

It has the same states as box step: active, completed, disabled.
And it contains the variations: color, inverted, size.

Due to it's design nature, it doesn't have the variations such
as: stackble, unstackable, attached and evenly divided.
Only the rail line after the completed step has particular color.
The other states use the default color for the rail line.
@ko2in
Copy link
Member Author

ko2in commented Oct 10, 2023

I’ve managed to add optional pulsating to active - https://codesandbox.io/s/fui-circular-step-forked-7tqhs6?file=/index.html - probably needs some tweaking … borrowed from transitions, though needs to target the ::before - I did try ::after as well, but think the former looks better on its own instead of the latter or both

@jamessampford You can submit your own PR later for any improvements. I would like to keep it as simple for now.

Copy link
Member

@lubber-de lubber-de left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's very awesome by now!
Just a little comment (see below) and a general question (not a request):

There are now a very lot of :not(.circular) selector enhancements.
Would it be easier (less code?) to instead override the circular setting (which would be needed for non circular only) instead directly. This is especially noticable for all the evenly divided variants (.x.steps)
I understand you did that because circular steps are styled differently, but perhaps it's worth some minutes to think about that again.

So instead of

.ui.steps:not(.circular) {
	display: inline-flex;
}

just override it for the ciscular variant like

.ui.steps {
	display: inline-flex;
}
.ui.circular.steps {
	display: block;
}

src/definitions/elements/step.less Outdated Show resolved Hide resolved
@ko2in
Copy link
Member Author

ko2in commented Oct 12, 2023

That's very awesome by now! Just a little comment (see below) and a general question (not a request):

There are now a very lot of :not(.circular) selector enhancements. Would it be easier (less code?) to instead override the circular setting (which would be needed for non circular only) instead directly. This is especially noticable for all the evenly divided variants (.x.steps) I understand you did that because circular steps are styled differently, but perhaps it's worth some minutes to think about that again.

So instead of

.ui.steps:not(.circular) {
	display: inline-flex;
}

just override it for the ciscular variant like

.ui.steps {
	display: inline-flex;
}
.ui.circular.steps {
	display: block;
}

I'll try to review again and find out whether it's possible to avoid excluding with :not(.circular) and describe the specific style directly.

@lubber-de
Copy link
Member

I tried to remove the :not(.circular) for the evenly divided variants (.two.steps, .three.steps etc.) and it seems it works well with circular variant (because it only affects the width), so at least those can be removed i think, but you may check yourself, too

@lubber-de lubber-de added the state/awaiting-docs Pull requests which need doc changes/additions label Oct 13, 2023
@ivangomes
Copy link

Guys this project still good?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lang/css Anything involving CSS state/awaiting-docs Pull requests which need doc changes/additions type/feat Any feature requests or improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants