ozyildirim / baklava

Design System with Web Components

Home Page:https://trendyol.github.io/baklava/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

image

Baklava Design System

npm package jsDelivr hits (npm scoped) semantic-release: angular

This is a work-in-progress version. If you want to work on previous version (Grace) please check main branch.

Baklava is a design system provided by Trendyol to create a consistent UI/UX for app users.

Web implementation of the design system is created as native web components so it can be used within every type of web frameworks including Vue, React or Angular. Our target is providing a UI library that has neatly designed and developed for providing best possible user experience for the users of applications that uses Baklava DS.

How to use

Preferred way of using Baklava is using it via CDN. Just import library JS and CSS files to your main document like below:

Since we are in beta version, there can be breaking changes in build. We don’t suggest you to use beta tag. Use versions instead.

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@trendyol/baklava@beta/dist/themes/default.css" />
<script type="module" src="https://cdn.jsdelivr.net/npm/@trendyol/baklava@beta/dist/baklava.js"></script>

This way library will be served from a very high performant CDN and all of the Baklava web components will be ready to use inside your web project.

⚠️ Because the scripts of the custom components are loaded into the DOM later, the baklava components may appear unstyled on the screen for a while. In order to avoid this 'FOUCE' effect, you can follow the instructions at this link.

Useful Links

About

Design System with Web Components

https://trendyol.github.io/baklava/

License:MIT License


Languages

Language:TypeScript 78.8%Language:CSS 16.0%Language:JavaScript 4.6%Language:HTML 0.6%Language:Shell 0.0%