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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document vertical spacing utilities #4092

Merged
merged 6 commits into from
Oct 29, 2021

Conversation

sowasred2012
Copy link
Contributor

@sowasred2012 sowasred2012 commented Oct 25, 2021

Done

Adding documentation and example around vertical spacing (u-sv) utilities.

Fixes #4026

QA

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 馃巵, Breaking Change 馃挘, Bug 馃悰, Documentation 馃摑, Maintenance 馃敤.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
    • if CSS class names are not changed it can be bugfix relesase (x.x.X)
    • if CSS class names are changed/added/removed it should be minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.
  • Documentation side navigation should be updated with the relevant labels.

@webteam-app
Copy link

Demo starting at https://vanilla-framework-4092.demos.haus

@sowasred2012 sowasred2012 force-pushed the sv-utils branch 2 times, most recently from 7cd4f1a to 0f41060 Compare October 25, 2021 11:22
@sowasred2012 sowasred2012 changed the title Documented vertical spacing utilities Document vertical spacing utilities Oct 25, 2021
Copy link
Contributor

@lyubomir-popov lyubomir-popov left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@bartaz bartaz left a comment

Choose a reason for hiding this comment

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

Some suggested rewording of do/donts

templates/docs/utilities/vertical-spacing.md Outdated Show resolved Hide resolved
templates/docs/utilities/vertical-spacing.md Outdated Show resolved Hide resolved
Co-authored-by: Bartek Szopka <83575+bartaz@users.noreply.github.com>
@bartaz
Copy link
Contributor

bartaz commented Oct 28, 2021

This turns out very long on screen.

Would the individual examples fit into columns side by side? Maybe 6 columns (if we drop the middle example without utility)?

Screenshot 2021-10-28 at 16 52 54

@bartaz
Copy link
Contributor

bartaz commented Oct 28, 2021

It also looks bit weird to have HTML code in the example text. I don't think we do it anywhere. It makes it look a bit confusing or as an error.

Maybe instead of <p> in text just keep the utility class name, and word "text" or "paragraph" in the one that is pushed without class name?

@sowasred2012
Copy link
Contributor Author

@bartaz

It also looks bit weird to have HTML code in the example text. I don't think we do it anywhere. It makes it look a bit confusing or as an error.

Maybe instead of <p> in text just keep the utility class name, and word "text" or "paragraph" in the one that is pushed without class name?

I was using this as a basis: https://vanillaframework.io/docs/examples/utilities/margin-collapse

@sowasred2012
Copy link
Contributor Author

@bartaz also - with columns it looks like this, which looks quite weird to me:

Screenshot from 2021-10-28 15-59-25

@bartaz bartaz merged commit 85a1a7e into canonical:vanilla-3.0 Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants