# Beginner's Guide


If you want to start using Storefront UI rather than reading about it's concepts please visit the getting started section.

Storefront UI is developer-friendly, customization-first and performance oriented component library that ships raw source. Designs are based on Google Retail UX Playbook.

Below you can find information about key concepts behind the project.

# StorefrontUI key characteristics

We are building Storefront UI based on the following 6 fundamentals:

  • Customization: Along with standard prop-based customization, every component has a set of slots that let you replace any part of it with your own images, icons or even custom HTML markup. You can also customize whole library from a single SCSS file by overriding set of variables.
  • Mobile-first: Every Storefront UI component is highly optimized for mobile user experience and in many cases behaves completely different on desktop and mobile. Select list becomes full-screen drop-down, tabs are becoming accordion etc.
  • Performance: You’re importing ONLY what you need, and in a raw format which means you can benefit from all build-time optimizations like tree shaking or grouping common chunks. Unused components are treeshaked and global CSS is just < 0,1 kB unminified. Thanks to this initial footprint of the library is unnoticable. You can use the library for how many components you want, even a single slider. You bundle only what you import.
  • Best practices: Storefront UI components follow best practices in terms of design and core. Every component is based on the Google Retail UX Playbook and is accessibility-friendly.
  • E-commerce: As a UI library dedicated to eCommerce, Storefront UI along with standard UI components has all the elements necessary for building modern online stores.
  • Open Source: Storefront UI is a community effort to deliver the best possible experience to modern web applications and e-commerce shops, with carefully crafted components following best practices. Our team consists of agencies and volunteer contributors from all over the world.

# Current state of the project

StorefrontUI is currently in BETA which means it is not suitable for production! The package is stable but some breaking changes may occur.

Currently we are focusing on API & component polishments and docs.

# Join us!

StorefrontUI is a completely new approach for component libraries oriented around customization possibilities instead of out of the box possibilities. It's a great goal but it will take a lot of time to achieve it only by ourselves. The project is open source and free to use.

If you'd like to support us and join the team please write to me: filip@vuestorefront.io 😉