From 8801ba6665289141fafd6054de8cec1c3bdbe371 Mon Sep 17 00:00:00 2001 From: Patrick Kunka Date: Mon, 7 May 2018 22:01:22 +0100 Subject: [PATCH] docs --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e9e8dd3..24fe2d0 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ EasyDropDown transforms the humble `` element API* @@ -31,13 +31,14 @@ Check out the **[demos](https://demos.kunkalabs.com/easydropdown/)** to see what - [Installation](#installation) - [Usage](#usage) + - [Single-instance instantiation](#single-instance-instantiation) + - [Batch instantiation](#batch-instantiation) - [Placeholder Functionality](#placeholder-functionality) - [Anatomy of EasyDropDown](#anatomy-of-easydropdown) - [Configuration Options](#configuration-options) - [Available Options](#available-options) - [API Methods](#configuration-options) -- [React Example](#react-example) -- [CSS Modules Example](#css-modules-example) +- [TypeScript Support](#typescript-support) - [Multiple Attribute Support](#multiple-attribute-support) ## Installation @@ -681,17 +682,11 @@ const edd = easydropdown(selectElement); edd.destroy(); ``` -## React Example +## TypeScript Support -... +EasyDropDown is written in [TypeScript](https://www.typescriptlang.org), and as such exports types for all API entry points and configuration interfaces, and providing full intellisense in compatible editors for a great developer experience. -## CSS Modules Example - -... - -## Typescript Support - -... +Additionally, if you are using CSS modules with TypeScript, a `theme.css.d.ts` type definition is provided in the [`themes`](./themes/) directory enumerating the entire `classNames` configuration object interface to help you author custom themes. ## Multiple Attribute Support