Getting Started
Welcome to {{projectName}}! This guide will help you get up and running quickly.
Installation
- npm
- Yarn
- CDN
Install via npm:
npm install domma-js
Install via Yarn:
yarn add domma-js
Include from CDN:
<link rel="stylesheet" href="https://unpkg.com/domma-js/dist/domma.css">
<script src="https://unpkg.com/domma-js/dist/domma.min.js"></script>
Configuration
Configure your project using the domma.config.json file:
{
"theme": {
"default": "charcoal-dark",
"persist": true
},
"navbar": {
"brand": { "text": "My App" },
"items": [
{ "text": "Home", "url": "/" }
]
}
}
Tip: You can override any configuration value programmatically using JavaScript.
Components
Domma includes 19+ UI components out of the box. Here are some examples:
Buttons
Badges
Primary
Success
Warning
Danger
Theming
Customize your theme by overriding CSS variables:
:root {
--dm-primary: #3b82f6;
--dm-primary-hover: #2563eb;
}
Or use one of the 16+ built-in themes:
Domma.theme.set('ocean-dark');
API Reference
Domma ($ alias)
jQuery-compatible DOM manipulation
$('#element').addClass('active');
$('.items').each((el) => console.log(el));
Domma.utils (_ alias)
Lodash-compatible utilities
_.chunk([1, 2, 3, 4], 2); // [[1, 2], [3, 4]]
_.debounce(fn, 300);
Domma.theme
Theme management
Domma.theme.init({ theme: 'ocean-dark' });
Domma.theme.get(); // 'ocean-dark'
Frequently Asked Questions
Is Domma production-ready?
Yes! Domma is actively maintained and used in production applications.
What browsers are supported?
Domma supports all modern browsers (Chrome, Firefox, Safari, Edge). IE11 is not supported.
Can I use Domma with React/Vue/Angular?
Yes! While Domma works standalone, you can integrate it with any framework for utilities and theming.