https://github.com/izadoesdev/nextless
https://github.com/izadoesdev/nextless
Last synced: about 20 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/izadoesdev/nextless
- Owner: izadoesdev
- Created: 2025-05-13T21:02:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-15T17:45:50.000Z (about 1 year ago)
- Last Synced: 2026-07-07T13:29:17.332Z (3 days ago)
- Language: TypeScript
- Size: 141 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nextless 🚀
**Unlock React's full potential, anywhere. Nextless provides framework-agnostic alternatives to popular Next.js components, giving you the power of modern web features without the framework lock-in.**
Are you looking to use Next.js-like conveniences such as optimized images, font loading, client-side navigation, or OG image generation in your Vite, Create React App, or custom React setup? Nextless is here to help! We're building a suite of high-quality, tree-shakeable React components that offer similar functionality to their Next.js counterparts, but with the freedom to use them in any React project.
## ✨ Features & Goals
* **Framework Agnostic:** Use in Vite, CRA, Astro, or your custom React build.
* **Familiar APIs:** Components designed to be intuitive, often mirroring Next.js patterns.
* **Performance Focused:** Optimized for speed, small bundle sizes, and best practices.
* **Tree-Shakeable:** Only include what you use.
* **Modern Tooling:** Built with Bun, TypeScript, and Biome.
* **Community Driven:** We aim to evolve with the needs of React developers.
## 📦 Installation
You can install Nextless components using your favorite package manager. As this project is under development, it's not yet published to NPM. Once published, you'll be able to install it like so:
```bash
# Using Bun (recommended for this project)
bun add @databuddy/nextless react react-dom
# Using npm
npm install @databuddy/nextless react react-dom
# Using yarn
yarn add @databuddy/nextless react react-dom
```
Ensure you have `react` and `react-dom` (version 18.0.0 or newer, or 19.0.0 or newer as per recent changes) as peer dependencies in your project.
## 🛠️ Components
Here's a list of components Nextless aims to provide, with their current status:
| Feature Replaced | Nextless Component | Status | Description |
| :--------------- | :----------------- | :---------- | :-------------------------------------------------------------------------- |
| `next/link` | `` | ✅ Alpha | Intelligent link component for internal/external navigation, router adaptable. |
| `next/image` | `` | 🚧 Planned | Performant image loading with lazy-loading, `srcset`, and modern formats. |
| `next/font` | ``| 🚧 Planned | Simplified font loading and optimization to reduce CLS. |
| `next/og` | `` | 🚧 Planned | Dynamic Open Graph image generation utilities. |
*(✅ Alpha/Beta/Stable, 🚧 Planned, ⏳ In Progress)*
## 🚀 Getting Started & Usage
### ``
The `` component provides a flexible way to handle navigation.
**Basic Usage:**
```tsx
import { SmartLink } from '@databuddy/nextless';
function App() {
return (
{/* External link (opens in new tab by default) */}
Visit Example
{/* Internal link (renders as by default) */}
About Us
{/* Explicitly external, opening in same tab */}
Visit Other Site (same tab)
);
}
```
**With React Router DOM:**
First, ensure `react-router-dom` is installed in your project.
```tsx
import { SmartLink } from '@databuddy/nextless';
import { Link as ReactRouterLink } from 'react-router-dom'; // Your router's Link component
function AppWithRouter() {
return (
Go to Dashboard
);
}
```
`` will pass relevant props like `to` (from `href`), `replace`, `state`, etc., to the `ReactRouterLink` component.
## 💻 Development Scripts
This project uses Bun for package management and execution.
* **Install Dependencies:**
```bash
bun install
```
* **Lint Code:**
```bash
bun run lint
```
* **Lint and Fix Code:**
```bash
bun run lint:fix
```
* **Format Code:**
```bash
bun run format
```
* **(Example) Run main entry point (currently outputs nothing specific):**
```bash
bun run index.ts
```
## 🤝 Contributing
Contributions are welcome! As the project is in its early stages, the best way to contribute is to:
1. Check the "Issues" tab for planned features or bugs.
2. Fork the repository.
3. Create a new branch for your feature or fix.
4. Implement your changes and ensure all checks pass (`bun run lint`, `bun run format`).
5. Submit a pull request with a clear description of your changes.
*(More detailed contribution guidelines will be added as the project matures.)*
## 📜 License
This project is intended to be open source. A specific license (e.g., MIT) will be formally added soon.
---
Built with ❤️ and Bun!