twilight-vscode-extension v1.0.3
Overview
Twilight JS Web Components are a collection of high-level building blocks and reusable web components that can be built together to swiftly develop the UI for custom Salla Themes, governed by clear guidelines. Twilight VSCode extension enhances the development experience by providing a set of featuers for the Twilight JS Web Components, such as autocomplete, code snippets and intellisense, when working in Visual Studio Code.
Getting Started
Installation
Twilight VSCode extension can be easily installed straight from the Visual Studio Code Marketplace.
Features
Salla's twilight VSCode extension has a range of rich features that includes:
Intellesense suggestions for the JS Web Components: When start writing any of the supported JS Web Component in the VSCode editor, the intelliSense feature will start showing a list of all the available components.
Syntax and Code Auto-completion: Writing code faster with fewer keystrokes result in saving time. That said, typos can be corrected with the autocomplete feature as well as enhancing consistency and compatibility based on the existing code and development style.
Usage
If you're familiar with the concept of JS Web Components or have read the official documentation, consider the following scenario; Let's say you want to add a Button component to your project. You can do this by typing:
<!-- Salla Default Button with no props -->
<salla-button>Hello World👋</salla-button>Components
Below is a list of the ready-made Twilight JS Web Components which can be used easily. Following, in this part of the document, each component is explained in detail.
| Component | Code Tag | Description |
|---|---|---|
| Branches | salla-branches | Header component that redirects merchants to a specific branch owned by the store. |
| Button | salla-button | Customizable Button component. |
| Infinite Scroll | salla-infinite-scroll | Items that can be scrolled infinitely. |
| Localization | salla-localization-modal | Modal dialoug which merchants can select languages/currencies from. |
| Login | salla-login-modal | Ready-made sign-in/sign-up modal. |
| Modal | salla-modal | Modal dialoug that momentarily prevents interactions. |
| Offer | salla-offer-modal | Modal dialoug which merchants can select offers related to product(s) they added to the cart. |
| Product Availability | salla-product-availability | Modal dialoug where registered merchants can be notified when a product is available. |
| Rating | salla-rating-modal | Modal dialoug prompting merchants to rate a store/product/shipping company after an order purchase has been completed. |
| Search | salla-search | Conduct the search capbility within the store. |
| Tel Input | salla-tel-input | Input field for accepting merchants' phone number, with country key/code prefix. |
| Verify | salla-verify | Dependent Salla Login component where merchants who have updated their Profile details are followed up with a verification modal. |
Support
The team is always here to help you. Happen to face an issue? Want to report a bug? You can submit one here on Github using the Issue Tracker. If you still have any questions, please contact us via the Telegram Bot or join in the Global Developer Community on Telegram.
Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Credits
License
The MIT License (MIT). Please see License File for more information.