> For the complete documentation index, see [llms.txt](https://wigxel.gitbook.io/react-components/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wigxel.gitbook.io/react-components/master.md).

# Getting Started

## Installation

{% hint style="info" %}
This UI library is dependant on **StyledComponents.** So every component in the library can be customized in the StyleComponents way
{% endhint %}

Installing the package for NPM. use node version 8+

```bash
$ npm install @wigxel/react-components styled-components
```

Installing the package from Yarn

```bash
$ yarn add @wigxel/react-components styled-components
```

###

### Adding Theme Variables

Create a Theme.js file

```bash
# bash
> touch src/Theme.js
```

Copy the Default Theme snippet below into the recently created Theme.js file.

{% code title="src/Theme.js" %}

```javascript
export default {
	colors: {
		primary: "#705DF5",
		accent: "#FFAA00",
		danger: "#E56464",
		grey: "#878787",
		greylight: "#848484",
		navbar: "#FDFDFD",
	},
	
	padding: {
		6: "2rem",
		12: "2.5rem",
	},
	
	alert: {
		info: { bg: "beige", text: "dodgerblue" },
		invite: { bg: "dodgerblue", text: "white" }
	},
	
	timeline: {
		borderColor: "blue",
		hoverColor: "whitesmoke"
	},
	
	...
}
```

{% endcode %}

Next, we have to pass the Theme variables via StyleComponents ThemeProvider.

{% code title="src/App.js" %}

```jsx
import { ThemeProvider } from 'styled-components'
import Theme from './Theme.js'

export default function App () {
    return 
    <ThemeProvider theme={Theme}>
        {/** 
            Using Components within the Theme Provider to add style 
            automatically 
        **/}
    </ThemeProvider>
}
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wigxel.gitbook.io/react-components/master.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.