@infinite-table/infinite-react 0.0.6 → 0.0.10

package/README.md

@@ -18,10 +18,9 @@
 
 - [Installation](#installation)
 - [Documentation](#documentation)
-- [Development process](#development-process)
-  - [Running the docs](#running-the-docs)
+- [❤️ TypeScript](#-typescript)
+- [🎨 Themable](#-themable)
 - [Testing](#testing)
-  - [Testing in development](#testing-in-development)
 - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -38,85 +37,26 @@ Our approach with the `InfiniteTable` is to go documentation first. From our dev
 
 **[Visit API docs](https://infinite-table.com/docs)**
 
-## Development process
+## ❤️ TypeScript
 
-You can start the examples by running:
+It's fully typed and offers you great developer experience to help you get up and running quickly
 
-```bash
-npm run dev
-```
-
-### Running the docs
-
-```bash
-npm run docs
-```
-<!-- 
-### HTML Element classNames
-
-- The table has the `ITable` className, and all HTML elements are prefixed with that.
-
-- All meaningful table parts (table row, header, cell) keep capitalized names, for example:
-
-  - `ITableRow`
-  - `ITableHeader`
-  - `ITableCell` - all cells, both in body and in header
-  - `ITableHeaderCell` - cells in header
-  - `ITableColumnCell` - cells in body rows
-
-- Other HTML elements, which are nested inside those table parts, will be prefixed with the table part where they are nested, followed by `_`. Example:
-
-  - `ITableCell_content`
-
-### CSS variables
-
-There are 2 kinds of variables:
-
-- top-level
-- component specific
+> The TypeScript typings file is included in the npm package - you don't have to download an additional **@types** package.
 
-All CSS variables meant primarily to be applied to a specific css property, will end up with `__<property-name>`, like this:
+## 🎨 Themable
 
-- `--it__border-radius`
+`Infinite Table` is fully customizable, via CSS variables. It ships with both a **light** and a **dark** theme - you have to import the CSS file from the package.
 
-#### CSS top-level variables
-
-Those are prefixed with `at-`. Examples:
-
-- `--it-font-size-0`
-- `--it-space-0`
-- `--it-space-1`
-- `--it-color-....`
-
-The ones meant primarily for a CSS property name will end with `__<property-name>`, like this:
-
-- `--it__border-radius` -->
+```js
+import "@infinite-table/infinite-react/index.css"
+```
 
+This file includes both the light and the dark themes.
 
 
 ## Testing
 
 Infinite Table is built with extensive end-to-end testing via headless chrome (more exactly, puppeteer).
-To execute the tests you have to run:
-
-```bash
-$ npm run test
-```
-
-Test pages are found in [tests folder](./source/examples/src/pages/tests) - which is part of a nextjs app where every file ending with `.page.tsx` is a page/route, while it's sibling file with the same name, but ending in `.test.tsx` is the actual test code. The test code is visiting the sibling page/route, to load the page and executes assertions against the test page.
-
-The test command command above does 3 things:
- 
- * compiles the nextjs app found in the [examples folder](./source/examples) - runs `next build && next export`, which creates an `out` folder with the resulting examples/tests app
- * starts a webserver that serves the generated `out` folder on [localhost:3000](http://localhost:3000)
- * runs jest+puppeteer against the app served at [localhost:3000](http://localhost:3000)
-
-### Testing in development
-
-If you want to run the tests in dev mode, to get feedback sooner, you need to run the following (in the [source/examples folder](./source/examples)):
-
- * `npm run dev` - to run the nextjs app in development, on port `3000`
- * `npm run test:watch` to run jest on changed files - optionally add a test path pattern like `npm run test:watch -- --testPathPattern=x/y/z`
 
 ## License 
 

package/index.css

@@ -619,6 +619,3 @@
   background: var(--infinite-load-mask-text-background);
   border-radius: var(--infinite-load-mask-border-radius);
 }
-
-
-/*# sourceMappingURL=tmp.css.map */