1.3.0 • Published 2 years ago

@robust-ui/tools

Licence

MIT

Version

1.3.0

Deps

Size

150 kB

Vulns

Weekly

Summary Dependency Versions

Robust
- Project Stats
Installation
- Usage
- Features
- Contributing
- License
Interfaces
- Interface: IOptions
  - Table of contents
  - Properties
@robust-ui/tools

@robust-ui/tools / Exports

Robust

Robust is a system for generating React components with real-time CSS injection. It is programmed in TypeScript, providing type safety and enhanced developer experience.

Installation

You can install Robust using either npm or pnpm. To do this, run one of the following commands:

Using npm:

npm install @robust-ui/core

Using pnpm:

pnpm install @robust-ui/core

using yarn:

yarn add @robust-ui/core

Alternatively, you can also download Robust from the GitHub repository and manually install the dependencies. The prepare script defined in the package.json file will automatically build all the files within the packages folder.

Usage

To use Robust, you need to make use of the Main component from the @robust-ui/nextjs-components repository. Note that the functionality has only been tested with Next.js and may not work in other React environments.

Here's an example of how to use Robust in a Next.js application:

import { Main, Header, Text, Icon, Flex } from "@robust-ui/nextjs-components";
import { SideMenu } from "@/components/drawer";
import type { AppProps } from "next/app";
import React from "react";

export default function App({ Component, pageProps }: AppProps) {
  const [open, setOpen] = React.useState(false);

  return (
    <Main color="white" fontFamily="Fira Code">
      <Header backgroundColor="gunMetal">
        <Flex>
          <Text fontWeight="700" fontSize="1.5rem">
            Nahuel
          </Text>
        </Flex>
        <Icon type="menu" onClick={() => setOpen(!open)} />
      </Header>
      <SideMenu open={open} setOpen={setOpen} />
      <Component {...pageProps} />
    </Main>
  );
}

In the above example, we import the necessary components from Robust and use them to create a basic application structure. The Main component sets the color and font family for the components. The Header component represents the application header, including a title and a menu icon that toggles the open state. The SideMenu component displays a side drawer with links and language options. Finally, we render the Component with the pageProps.

Please note that this usage example is specific to Next.js, and the functionality may not be tested or supported in other React environments. Make sure to customize the components and their properties based on your specific requirements.

Features

Robust includes the following features:

Automatic responsiveness: The components are designed to adapt to different screen sizes and orientations.
Quick language switching: Easily switch between different languages using the language options provided.
Dark mode: The system supports a dark mode theme that can be enabled or disabled.
Global states: Robust provides mechanisms for managing global states and sharing data between components.
Real-time CSS injection: The system injects CSS in real time, allowing for dynamic styling and theming.
TypeScript support: Robust is programmed in TypeScript, providing type safety and enhanced developer experience.
Customizable components: The components can be customized using various properties to suit your specific requirements.
Easy to use: Robust is designed to be easy to use and integrate with existing React applications.
Extensible: The system can be extended with additional components and functionality as needed.
Well-documented: The codebase is well-documented, making it easy to understand and contribute to.
Active development: Robust is actively developed and maintained, with regular updates and improvements.

Contributing

Contributions to Robust are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

License

Robust is released under the MIT License.

Interfaces

@robust-ui/tools / Exports / IOptions

Interface: IOptions

Properties

digest

• digest: BinaryToTextEncoding

Name	Type
`«destructured»`	`Object`
› `inputAttributes`	`Record`<`string`, `unknown`>
› `mediaBreakpoints`	`Record`<`string`, `number`>

Name	Type	Default value	Description
`options`	`Object`	`undefined`	The options for the debounced function.
`options.delay?`	`number`	`0`	The delay in milliseconds before invoking the debounced function.
`options.fn`	`T`	`undefined`	The function to debounce.
`options.immediate?`	`boolean`	`false`	Specifies whether the debounced function should be invoked immediately on the leading edge.

Name	Type
`«destructured»`	`Object`
› `inputString`	`string`
› `options?`	`IOptions`

Name	Type
`«destructured»`	`Object`
› `object`	`unknown`
› `options?`	`IOptions`
› `prefix?`	`string`

Name	Type
`«destructured»`	`Object`
› `children`	`ReactNode`
› `props`	`HTMLAttributes`<`HTMLElement`>

Name	Type
`htmlProps`	`Record`<`string`, `unknown`>
`styleProps`	`Record`<`string`, `unknown`>

Name	Type
`«destructured»`	`Object`
› `indentation?`	`string` \| `number`
› `object`	`unknown`
› `replacerFunction?`	(`key`: `string`, `value`: `unknown`) => `unknown`

Name	Type	Description
`children`	`Object`	The React children elements.
`children.children`	`ReactNode`	-