0.0.1 • Published 9 months ago

unoapps-library v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
9 months ago

Uno apps component library

Table of Contents

What is this repository for?

This is a package to keep common components for singular uno apps.

Reusable Components: A variety of pre-built components for faster development. Customizable: Easily customize components to fit your design needs.

Installation

Install library as a dependency to your project.

npm

npm install unoappslibrary

Usage

Basic usage

Example of importing and using CheckButton

jsx or tsx

import { CheckButton } from "unoAppsLibrary";


const AppComponent = () => {
  return (
    <div>
      <Header />
      <CheckButton {...checkButtonProps} />
      <Footer />
    </div>
  );
};

Available Components

ComponentPropertyTypeRequired?Default valueDescription
AppJs
singularAppRecord<string, any>yes
useAppJsStore() => Record<string, any>, React.Dispatch<Record<string, any>>yes
configRecord<string, any>yes
AppStorageanyyes
CompositionManagerRecord<string, any>yes
hideCustomizeTileboolean?no
hideSettingsTileboolean?no
Button
valuestringyes
onChangeFunctionyes
disabledboolean?no
...otherPropsDetailedHTMLPropsno-All other props from DetailedHTMLProps
CheckButton
valuebooleanyes
onChangeFunctionyes
labelOnstring?no
labelOffstring?no
disabledboolean?no
smallboolean?no
Clock
valueanyyes
onChange(value: any) => voidyes
showSecondsboolean?no
showMinutesboolean?no
showHoursboolean?no
Colortype ColorRecord = { type: string; solidColor: string; };
valueColorRecord | stringyes
onChangeFunctionyes
disabledboolean?no
getPopoverParentFunction?no
Counter
valuestring | numberyes
onChangeFunctionyes
resetnumberyes
disabledboolean?no
maxnumber | string?no
minnumber | string?no
unitstring?no
modifyButtonsany[]?no
setButtonsany[]?no
DataSourceConnect
typestringyes
templateUrlstringyes
connectedUrlstringyes
DateTime
valuenumber | stringyes
onChangeFunctionyes
disabledboolean?no
Duration
valuestring | numberyes
onChangeFunctionyes
EditorCarousell
isSettingsTileRemovedbooleanyes
removeNavigationMenubooleanyes
childrenReactNodeyes
FieldMapper
modelany[]yes
dataany[]yes
dataMappingRecord<string, any>yes
onChangeFunctionyes
FillInForm
fieldsany[]
groupsany[]yes
payloadRecord<string, any>yes
subCompIdstring?no
imageBrowserAvailablebooleanyes
showStylebooleanyes
groupExpandedRecord<string, any>yes
onChangeFunctionyes
onOpenImageBrowserFunctionyes
onGroupExpandedFunctionyes
getPopoverParentFunctionyes
Image
valuestringyes
onChangeFunctionyes
getPopoverParentFunction?no
disabledboolean?no
imageBrowserAvailableboolean?no
onOpenImageBrowseranyyes
ImageBrowser
InfoText
valuestringyes
Location
valueRecord<string, any>yes
onChangeFunctionyes
disabledboolean?no
NumberField
valuenumber | stringyes
onChange() => voidyes
disabledboolean?no
Panel
headerlessboolean?no
fieldlistboolean?no
splitPaneboolean?no
logicLayersboolean?no
noTopMarginboolean?no
outputPlayerboolean?no
splitboolean?no
tabularDataboolean?no
classNamestring?no
collapsedboolean?no
Playlist
dataany[]yes
valuenumberyes
columnsany[]yes
onChangeFunctionyes
PresetSelect
valueanyyes
onChangeFunctionyes
disabledboolean?no
sourcestring?no
sourceUrlstring?no
formatstring?no
useReloadboolean?no
useCustomizeboolean?no
isSearchableanyyes
onPresetCustomizationanyyes
Radio
options{id: string; label: string}[]yes
valuestringyes
onChangeFunctionyes
itemsPerRownumber?no
Search
modeenter' | 'key'yes
placeholderstring?no
OnSearchFunctionyes
Select
valuestringyes
onChangeFunctionyes
useReloadbooleanyes
disabledboolean?no
sourcestring?no
sourceUrlstring?no
formatstring?no
isSearchableboolean?no
optionsany[]?no
TextArea
valuestring | numberyes
onChangeFunctionyes
disabledboolean?no
TextField
valuestring | numberyes
onChangeFunctionyes
disabledboolean?no
TimeControl
valueRecord<string, any>yes
onChangeFunctionyes
disabledboolean?no

Storybook

You can run the storybook locally

npm

npm run storybook

Changelog

All notable changes to this project will be documented in the CHANGELOG.md.

License