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

Docs: Feature/playground demos #178

Merged
merged 16 commits into from
Mar 8, 2024
Merged

Conversation

perruche
Copy link
Contributor

@perruche perruche commented Mar 7, 2024

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Add a demos section in the documentation to provide copy/paste ready code exemple.

  • For dev to quickly implement already built components
  • For designers to browse easily through the demos

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.
  • I have updated the changelog.

@perruche perruche added the documentation Improvements or additions to documentation label Mar 7, 2024
Copy link

github-actions bot commented Mar 7, 2024

Export Size

Unchanged

@studiometa/ui

Name Size Diff
AbstractPrefetch 411 B -
AbstractScrollAnimation 461 B -
AbstractSliderChild 2.42 kB -
Accordion 1.06 kB -
AccordionItem 1.02 kB -
Action 508 B -
ALL 11.07 kB -
AnchorScrollTo 243 B -
animationScrollWithEase 272 B -
ATOMS 3.77 kB -
CircularMarquee 339 B -
Cursor 665 B -
Draggable 327 B -
Figure 694 B -
FigureTwicpics 1.15 kB -
Frame 1.62 kB -
FrameAnchor 201 B -
FrameForm 198 B -
FrameTarget 777 B -
LargeText 492 B -
LazyInclude 418 B -
loadImage 694 B -
Menu 1.38 kB -
MenuBtn 230 B -
MenuList 943 B -
Modal 908 B -
ModalWithTransition 1.02 kB -
MOLECULES 6.83 kB -
ORGANISMS 1.68 kB -
Panel 1.26 kB -
PrefetchWhenOver 468 B -
PrefetchWhenVisible 480 B -
PRIMITIVES 632 B -
ScrollAnimation 513 B -
ScrollAnimationChild 650 B -
ScrollAnimationChildWithEase 851 B -
ScrollAnimationParent 712 B -
ScrollAnimationWithEase 711 B -
ScrollReveal 622 B -
Sentinel 217 B -
Slider 2.21 kB -
SliderBtn 2.58 kB -
SliderCount 2.45 kB -
SliderDots 2.67 kB -
SliderDrag 353 B -
SliderItem 705 B -
SliderProgress 2.49 kB -
Sticky 859 B -
TableOfContent 647 B -
TableOfContentAnchor 460 B -
Tabs 625 B -
Transition 387 B -

Copy link

codecov bot commented Mar 7, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 27.27%. Comparing base (1109e24) to head (6609619).

❗ Current head 6609619 differs from pull request most recent head 382ecb8. Consider uploading reports for the commit 382ecb8 to get more accurate results

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #178   +/-   ##
========================================
  Coverage    27.27%   27.27%           
========================================
  Files           48       48           
  Lines         1199     1199           
  Branches       237      237           
========================================
  Hits           327      327           
  Misses         806      806           
  Partials        66       66           
Flag Coverage Ξ”
unittests 27.27% <ΓΈ> (ΓΈ)

Flags with carried forward coverage won't be shown. Click here to find out more.

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

Copy link
Contributor

@titouanmathis titouanmathis left a comment

Choose a reason for hiding this comment

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

Nice addition!

There is a small error in one of the Twig template that requires fixing. Could you also update the changelog?

packages/docs/demos/SliderVertical/stories/app.twig Outdated Show resolved Hide resolved
@titouanmathis titouanmathis merged commit 7bb9f83 into develop Mar 8, 2024
5 of 6 checks passed
@titouanmathis titouanmathis deleted the feature/playground-demos branch March 8, 2024 14:12
@titouanmathis titouanmathis mentioned this pull request Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants