SM Components
Getting Started
Components
Total components
Overview
Component-based design is the cornerstone of the modern UI development process. With rise of more UI frameworks every day, the web platform has a serious issue of fragmentation and portability.
Web components to the rescue! This is the collection of web components (WC here forward) that we use at RanchiMall, especially since we are a framework-less development environment so this was a logical choice.
Just download the components you like, link them with a script tag and drop it in HTML done!
Features
- Native and Cross framework support
- Encapsulated style and functionality
- Easy styling
- Adaptive scaling
Quick Start
- To start using these components, Select the ones you want to add to your project. You can un-check 'get minified' to get the readable code.
- Now you can download or copy the source code for selected components. You might get a warning while downloading like this file is not safe, please allow the download as this is caused when downloading files with '.js' extension. These components are 100% safe to use.
-
Link the downloaded js before </body>
<script src=".../components.js"></script>
Global styling
These components use CSS variables to customize styling. they share some CSS
variables that make global styling easier.
Of course you can set these variables at individual component CSS rule set level.
Some common CSS variables and their use
Variable
Use
Color which will be used for denoting active state
default text color for all components.
( Use comma separated rgb values. e.g 17, 17, 17 )
default background color for all components.
( Use comma separated rgb values. e.g 255, 255, 255 )
Used for error/invalid state
Buttons
Variants
These are styled variations of base component
Variant type
Example
How to define variant
<sm-button variant="primary">primary</sm-button>
<sm-button variant="outlined">outlined</sm-button>
<sm-button variant="no-outline">no-outline</sm-button>
States
Disabled
To disable the button add disabled attribute.
<sm-button disabled>Disabled</sm-button>
Attributes
All the native HTML checkbox attributes are valid
Attribute
Description
Button is disabled by default. all the interactions are disabled
Has values submit reset
Can only used withing
Styling
CSS variables used to style this component
Variable
Description
Define background of button. accepts all values of CSS background property
Set curvature at button corners
Specify padding of button
Carousel
Carousel is a very common UI component primarily used to display images or slides. This carousel switches user interactions based on type of input devices present. For hover capable devices slides can be scrolled with buttons and on touch enabled devices swipe can be used.
Interactive demo
Title
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Provident, optio.
Title
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Provident, optio.
Title
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Provident, optio.
Title
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Provident, optio.
<sm-carousel align-items="start" indicator> ...carousel items... </sm-carousel>
Custom attributes
These attributes cane used to customize carousel behaviour and features
Attribute
Description
Has values start center end Specifies how carousel items should align. default is center.
if added carousel shows dot indicators of carousel items.
Styling
CSS variables used to style this component
Variable
Description
Defines background color of active slide indicator
Defines background color of carousel navigation buttons
Defines box shadow of carousel navigation buttons
Defines fill of arrow icon on carousel navigation buttons
Checkbox
sm-checkbox supports all the attributes of native HTML5 checkbox
linking some HTML element with sm-checbox using label tag won't work.Add the element inside the opening and closing checkbox tag.
Interactive demo
States
Disabled
To disable the checkbox add disabled attribute.
<sm-checkbox disabled>
<div style="margin-left: 0.5rem;">Disabled checkbox</div>
</sm-checkbox>
Checked
To make checkbox checked by default add checked attribute.
<sm-checkbox checked>
<div style="margin-left: 0.5rem;">Checked checkbox</div>
</sm-checkbox>
Attributes
All the native HTML checkbox attributes are valid
Attribute
Description
Sets checked state as default if added
Checkbox is disabled by default. all the interactions are disabled
Sets value of checkbox which can be accessed by value property with JS
Styling
CSS variables used to style this component
Variable
Description
Defines border-radius of checkbox square
Defines height of checkbox
Defines width of checkbox
Copy
To start using SM Components
File input
<file-input> is essentially native <input type="file"/>
with added style.
So every attribute supported by native file input is supported as can be used in exactly same way.
Interactive demo
<file-input multiple>Select multiple files</file-input>
Attributes
Attribute
Description
One or more unique file type specifiers describing file types to allow
What source to use for capturing image or video data
A FileList listing the chosen files
A Boolean which, if present, indicates that the user may choose more than one file
Form
Browser support for web components form validation or form submition is not perfect. so to circumvent this problem <sm-form> can be used.
Interactive demo
Supported functions
Function
Description
When this function is called upon form element. all the form elements (sm- form elements only) will be reset to default state.
Nested element behaviour
Hamburger menu
Input
Interactive demo
<sm-input id="my_input" placeholder="Email" type="email" value="john@doe" animate></sm-input>
Variants
outlined is only one styled variation. Default is filled which doesn't require variant specified.
<sm-input placeholder="Name" variant="outlined" animate></sm-input>
Custom Attributes
All the native HTML input attributes are valid. These are additional attributes which can be used to add more functionality
Attribute
Description
If present, placeholder of input will be animated to occupy space above enterned text instead of vanishing.
Message specified as value of this attribute will be shown if validation fails.
Supported functions
Function
Description
To give focus to this component use this function instead of focus()
When this function is called upon form element. all the form elements (sm- form elements only) will be reset to default state.
Custom Setters
Function
Description
If you want to perform custom validation on input value, set the desired validation function.
/* Setting custom validation function */
document.getElelementById('my_input').customValidation = myValidation
Menu
To start using SM Components
Notifications
To start using SM Components
Example
Popup / dialog
Popups are used to show addition UI elements that you may want to hide at first and reveal them when needed.
idhfioushdfiuh
idhfioushdfiuh
idhfioushdfiuh
idhfioushdfiuh
idhfioushdfiuh
idhfioushdfiuh
idhfioushdfiuh
idhfioushdfiuh
Radio
Popups are used to show addition UI elements that you may want to hide at first and reveal them when needed.
Switch
To start using SM Components
Select
<sm-select> is very similar to starndatd HTML5 select and it's markup stucture is also identical.
Spinner
<sm-select> is very similar to starndatd HTML5 select and it's markup stucture is also identical.
Strip select
To start using SM Components
Tabs
To start using SM Components
bdfjnbj
flkmgklfmzkl
hbdsfhb
Tags input
To start using SM Components
Textarea
To start using SM Components
Text field
To start using SM Components