Overview
Component in Coffeekraken is very important part of our vision, and this, even is as everything else, they can be used or not inside your project. Totally your decision.
What are components?
We call component
everything that takes place inside your HTML like a button
, a form input
, etc...
Inside the component category, we also include web
components. These are new custom elements that you can use within your HTML like s-date-picker
, s-color-picker
, s-panel
, etc...
Official components
Here's the list of currently official available components:
- Fs Tree
- Icons
- Tooltips
- Avatar
- Backdrop
- Badges
- Blockquote
- Buttons
- Card
- Dropdown
- Fs Tree
- Group
- Icons
- Lists
- Loaders
- Media
- Scrollbar
- Table
- Tabs
- Toggles
- Tooltips
And here's the list of our official web
components:
- SClipboardCopyComponent
- SCodeExampleComponent
- SColorPickerComponent
- SDatetimePickerComponent
- SFiltrableInputComponent
- SGoogleMapComponent
- SPanelComponent
- SRangeComponent
- SRatingComponent
- SScrollComponent
- SSliderComponent
- SThemeSwitcherComponent
Components MUST follow some simple rules
All the components that we provide follows these simple rules:
- A component MUST be as customizable as possible
- A component MUST provide at least 2
scopes
:- The "bare" scope that contain all the structural css for your component to work.
- Usually loaded directly in your JS file.
- The "lnf" (look and feel) scope that provides optional visual styling.
- Usually provided through a
@sugar.ui.componentName.classes
mixin - MUST take in consideration the theme configurations.
- Usually provided through a
- The "bare" scope that contain all the structural css for your component to work.
- A component MUST work out of the box without anything more to do
- A component MUST follow your
theme
specifications if thelnf
(look and feel)scope
is applied