@okaapp/oka-ui-sv

v0.4.6

Published

17 days ago

OKA UI Svelte components library for the Appta software platform

0High
0Medium
0Low

ollieisintrouble

trucnguyen1106

svelte

OKA UI for Svelte

OKA Tech UI Svelte component library built for the Appta software platform, offering a collection of customizable, accessible, and themeable components.

Installation

npm install @okaapp/oka-ui-sv

Required Peer Dependencies

This library requires the following peer dependencies to be installed:

npm install svelte@^5.0.0 @sveltejs/kit@^2.22.0 bits-ui@^2.9.8 phosphor-svelte@^3.0.1

Setup

1. Style Provider

All components must be wrapped in the OKAStyleProvider component for proper styling. Add it to your root layout file:

<!-- src/routes/+layout.svelte -->
<script lang="ts">
    import { OKAStyleProvider } from "@okaapp/oka-ui-sv";
</script>

<OKAStyleProvider>
    <slot />
</OKAStyleProvider>

2. Theme Setup

To avoid Flash of Unstyled Content (FOUC), add the following script to your app's HTML file:

<!-- src/app.html -->
<body>
    <div>%sveltekit.body%</div>
    <script>
        const savedTheme = localStorage.getItem('theme') || 'default-light';
        document.body.classList.add(savedTheme);
    </script>
</body>

Available Themes

OKA UI comes with several built-in themes:

Light themes:
- default-light
- neutral-light
- nord-light
Dark themes:
- default-dark
- neutral-dark
- nord-dark
Fengshui themes:
- fengshui-kim (Metal)
- fengshui-moc (Wood)
- fengshui-thuy (Water)
- fengshui-hoa (Fire)
- fengshui-tho (Earth)

Components

Core Components as of 0.4.2

Avatar
Badge
Button
Checkbox
Dialog
Input
Loading
Pagination
PinInput
Select (Single & Multi)
Separator
Sidebar
Tooltips

Usage Example

<script>
    import { Button, Avatar, Badge } from "@okaapp/oka-ui-sv";
</script>

<Button variant="primary">Click me</Button>

<Avatar src="/path/to/image.jpg" alt="User avatar" size="md" />

<Badge color="success">Complete</Badge>

Theme Switching

The library includes a ThemeSwitcher component for easy theme management:

<script>
    import { ThemeSwitcher } from "@okaapp/oka-ui-sv";
</script>

<ThemeSwitcher />

Contributing

Contributions are welcome! Please read our contributing guidelines before submitting pull requests.

License

MIT License - see LICENSE file for details.

Acknowledgments

Built with: