@ressjs/core
v0.3.0
Published
Core utilities for ress.js
Readme
@ressjs/core
Core utilities and components for ress.js framework.
Installation
npm install @ressjs/coreFeatures
- Page Generation: Automatic page entry generation for SSR and client-side hydration
- Platform Detection: Support for mobile, desktop, and webview-specific builds
- SSR Utilities: Server-side rendering helpers and components
- Asset Management: Efficient handling of CSS and JavaScript assets
Usage
Basic Page Generation
import { generateTempEntries, getClientEntriesInput } from '@ressjs/core';
// Generate temporary entry files for all pages
await generateTempEntries('dist');
// Get client entry configuration for Vite
const entries = await getClientEntriesInput('dist');Platform-Specific Builds
The core package automatically detects and generates platform-specific entries:
index.scss- Base stylesindex.mobile.scss- Mobile-specific stylesindex.desktop.linux.scss- Desktop Linux-specific styles
SSR Components
import { render } from '@ressjs/core';
// Server-side rendering with platform detection
const html = await render(Component, { platform: 'mobile' });API Reference
Functions
generateTempEntries(distPath?: string)
Generates temporary entry files for all pages with platform-specific variants.
getClientEntriesInput(distPath?: string)
Returns Vite entry configuration object for client-side builds.
render(component, options)
Server-side rendering function with platform detection support.
Platform Detection
The core package supports automatic platform detection based on user agent:
- Mobile: iOS Safari, Android Chrome, mobile browsers
- Desktop: Desktop browsers, electron apps
- WebView: Embedded webview contexts
License
MIT - see LICENSE for details.
Contributing
See the main ress.js repository for contribution guidelines.
