Nekomata-ui

Nekomata-ui is an UI component library build with Svelte that focuses on delivering components and features that can be adaptable to your application needs.

Currently in development

This library is being build with the idea that you can follow any set of design guidelines/philosophies to reach the design you want for your application. This means there is no enforcement into certain design guidelines/philosophies by Nekomata-ui.

Nekomata-ui tries to be that by:

• Exporting CSS custom properties (variables) from our components which can be used to alter how they work on the screen.
• Components are not build with pre-defined media queries or a dependency to a store with breakpoints. (The aim is to have components with profiles (css classes) that you can alter and set from the outside)

Installation

npm install --save-dev nekomata-ui

Components:

• AppBar
• AccordionPanel (initial version)
• Button (icon) (initial version)
• FlexBox (Was Row in 2.5 and before)
• GridContainer (initial version)
• Overlay
• SvgIcon
• Drawer (initial modal version)

Utils:

• styleStringBuilder (Turning an object into a css style string)

Features:

• themeStore
  • For switching the theme from light to dark and the other way around.
  • Uses the Local Storage from the browser to store the state between visits.
  • Make the page load without visible theme switching onload (see flash going from light to dark)

Check the website for more information about the features. Website is still under construction!

Code coverage:

| Nekomata-ui | Unit tests (dev) | Unit tests | Integration tests | |:-:|:-:|:-:|:-:| | Components| | - | - | | Features | - | - | - |

Contributing

New ideas and improvements are very welcome and will help the library grow. See contributing how you can contribute.

Climate policy

Nekomata-ui is very concerned about the climate. For this reason, packages that are one year old will be given the deprecated status and then removed from services such as NPM after six months. (Only applicable to services on which nekomata-ui releases were released directly)

Changelog:

• 0.3.0: Library migration to SvelteKit.
• 0.2.11: AccordionPanel max-height: max-content changed to 100%.
• 0.2.8: AccordionPanel added.
• 0.2.7: Small fixes for the drawer and flexbox.
• 0.2.6: Library updates and Row has been changed to FlexBox with column as available variant.
• 0.2.4: Overlay added and aria-label added to the Button component.
• 0.2.3: Export fix.
• 0.2.2: Button (icon) (initial version), BreakpointStore (experimental) based on the Smelte breakpointstore added. Appbar, Button and SvgIcon now have 2 css profiles (more info will follow)
• 0.2.1: Dependencies update and an change to the setThemeOnLoad() method from the ThemeStore.
• 0.2.0: styleStringBuilder added. CSS media queries removed from the components. Rewrite of the CSS custom properties to make them more unique. Every component now has a type interface that can be used to make an object. This can be used by the styleStringBuilder to make a css style string for a component. All components now have an id attribute that can be set. Which makes it possible to navigate to the component and to target the component from the outside by JavaScript and CSS. All components now have and data_testid that can used to set and testId for the Svelte testing library.
• 0.1.8: (modal) drawer added without backdrop (initial version).
• 0.1.7: CssStyleString changed to $: style.
• 0.1.6: SvgIcon test fixes and package structure changes.
• 0.1.5: Fix package.json export.
• 0.1.3: $$restProps.class changed to a clazz as class export.
• 0.1.1: Custom style prop added to components.
• 0.1.0: SvgIcon added and a few fixes.
• 0.0.8: GridContainer (initial version) added.
• 0.0.7: Row component added.
• 0.0.4: Initial AppBar component added.
• 0.0.3: themeStore export bug fixed.
• 0.0.2: themeStore added.