@kelvininc/ui-components/docs/components/loader/readme.md

Kelvin UI Components

<!-- Auto Generated Below -->


## Usage

### Javascript

```html
<!-- Default -->
<kv-loader is-loading />

<!-- Has Overlay -->
<kv-loader is-loading has-overlay />
```


### React

```tsx
import React from 'react';

import { KvLoader } from '@kelvininc/react-ui-components';

export const LoaderExample: React.FC = () => (
  <>
    {/*-- Default --*/}
	<KvLoader is-loading />

	{/*-- Has Overlay --*/}
	<KvLoader is-loading has-overlay />
  </>
);

```


### Stencil

```tsx
import { Component, h } from '@stencil/core';

@Component({
  tag: 'loader-example',
  styleUrl: 'loader-example.css',
  shadow: true,
})
export class LoaderExample {
  render() {
    return [
      	// Default
		<kv-loader is-loading />

		// Has Overlay
		<kv-loader is-loading has-overlay />
    ];
  }
}
```



## Properties

| Property     | Attribute     | Description                                | Type      | Default |
| ------------ | ------------- | ------------------------------------------ | --------- | ------- |
| `hasOverlay` | `has-overlay` | (optional) If `true` the loader is overlay | `boolean` | `false` |
| `isLoading`  | `is-loading`  | (optional) If `true` the loader is enabled | `boolean` | `false` |


## CSS Custom Properties

| Name                        | Description              |
| --------------------------- | ------------------------ |
| `--loader-background-color` | Loader background        |
| `--loader-overlay-color`    | Overlay color            |
| `--loader-overlay-opacity`  | Overlay opacity          |
| `--loader-spinner-color`    | Loader color             |
| `--loader-z-index`          | Loader z-index position. |


----------------------------------------------