@dosullivan557/nucleus
v0.9.1
Published
Nucleus — A core library of reusable React components and custom hooks that form the foundation of your projects. Lightweight, modular, and developer-friendly, Nucleus helps you build clean, scalable React apps faster by providing essential building block
Maintainers
Readme
Nucleus
Nucleus is a modular, developer-friendly core library of reusable React components, regular expressions and custom hooks—designed to be the foundation of clean, scalable React applications.
Whether you're building a small prototype or a large-scale SPA, Nucleus provides essential UI building blocks and logic abstractions out of the box, helping you ship faster with consistent design and logic.
🚀 Quick Start
npm install @dosullivan557/nucleus
# or
yarn add @dosullivan557/nucleus📚 Documentation
👉 Full documentation & live examples
- Component and hook API reference
- Usage examples
- Installation tips
- Contribution guide
- Changelog
🧩 Components
🪝 Hooks
- useAsyncHook: Async state management (docs)
- useDebounce: Debounce side effects (docs)
- useFetch: Data fetching (docs)
- useLocalStorage: State sync with localStorage (docs)
- useScreenDimensions: Window size (docs)
- useTimeout: Timeout management (docs)
- useToggle: Boolean toggle (docs)
Regular Expressions
We export both a wrapper function for simplicity, as well as the raw regular expression for more complicated workflows
- email
- isValidEmail
- emailRegex
🧪 Testing & Development
- Run tests:
npm test - Lint:
npm run lint - Format:
npm run format - Storybook:
npm run storybook
🤝 Contributing
See CONTRIBUTING.md for guidelines.
📄 License
MIT © Danny O'Sullivan
