Package Exports
- @smtv/tv-component-library
- @smtv/tv-component-library/dist/index.esm.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@smtv/tv-component-library) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@smtv/tv-component-library
A TV-optimized React component library for audio streaming applications.
Features
- TV-specific UI components
- Remote control navigation support
- Accessibility-focused design
- Dark mode by default
- Built with TypeScript
- Storybook documentation
Installation
npm install @smtv/tv-component-library
Usage
import { ChannelCard } from '@smtv/tv-component-library';
function App() {
return (
<ChannelCard
title="Channel Name"
description="Channel description"
// Add other props as needed
/>
);
}
Development
- Clone the repository
- Install dependencies:
npm install
- Start Storybook:
npm run storybook
- Build the library:
npm run build
Publishing to npm
After editing or adding components, follow these steps to publish a new version to npm:
- Pull the latest changes
git pull origin main
- Install dependencies (if you haven't already)
npm install
- Build the library
npm run build
- Commit and push your changes to GitHub
git add . git commit -m "commit message" git push origin main
- Update the version number in
package.json
- Follow semantic versioning:
- Patch: bug fixes
- Minor: new features/components
- Major: breaking changes
- Example: change
"version": "1.2.3"
to"version": "1.2.4"
- Or use the CLI to bump the patch version:
npm version patch
- Follow semantic versioning:
- Login to npm (if not already logged in)
npm login
- Publish the package
npm publish --access public
Note:
- You must have permission to publish to the npm package.
- If you encounter any issues, ask a developer for help.
Documentation
Visit our Storybook documentation for detailed component documentation and examples.
License
ISC