https://github.com/sangupta/twist-lib
Components for React+Twist
https://github.com/sangupta/twist-lib
Last synced: 2 months ago
JSON representation
Components for React+Twist
- Host: GitHub
- URL: https://github.com/sangupta/twist-lib
- Owner: sangupta
- Created: 2018-02-25T21:14:33.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-15T00:08:40.000Z (over 7 years ago)
- Last Synced: 2025-03-30T13:03:53.334Z (10 months ago)
- Language: TypeScript
- Size: 63.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Twist Lib
A collection of components and utility classes to be used in
conjunction with Adobe Twist framework.
* [Available Components](#available-components)
* [Usage](#usage)
* [Dependencies](#dependencies)
* [Hacking](#hacking)
* [Webpack](#webpack)
* [Rollup](#rollup)
* [Typescript](#typescript)
* [ParcelJS](#parceljs)
* [Versioning](#versioning)
* [License](#license)
## Available Components
* WindowSizeAware - helps with responsive page contruction
* InfinteScroll - for the infinite scroll
* Bootstrap components
## Usage
To use this library:
```
$ yarn install --dev twist-lib
# yarn is preferred but works with npm as well
$ npm install --save-dev twist-lib
```
To use the Bootstrap based components, include the CSS file in your
HTML source code yourself. This is done to reduce the size of the JS
bundle that changes often.
The current Bootstrap 4.1 documentation mentions to use the following
include for the CSS:
```
```
## Dependencies
* React 16+
* Adobe Twist
## Hacking
There are 2 branches in the project:
* `master`: this includes the latest codebase
* `typescript`: this has errors in typescript compilation. See below for
more details.
### Webpack
Building via `webpack` is done:
```
$ npm run build
```
### Rollup
`rollup` compilation currently only builds `index.ts` file and generates
just the pure imports. A single bundle build via `rollup` could not be generated
due to lack of experience with the tool.
Packaging via `rollup` was tried using:
```
$ rollup src/index.ts --format iife --name "twistlib" --file bundle.js
```
### Typescript
The source code contains type declarations to open project in Visual Studio
Code, however, the `typescript` compiler fails with errors as we cannot add
default intrinsic JSX properties.
`typescript` compiler can be fired using:
```
$ tsc
```
### ParcelJS
Hopefully we will be able to compile using ParcelJS one day via:
```
$ parcel src/index.ts
```
## Versioning
For transparency and insight into our release cycle, and for striving
to maintain backward compatibility, `twist-lib` will be maintained under
the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the follow format:
```
..
```
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major
* New additions without breaking backward compatibility bumps the minor
* Bug fixes and misc changes bump the patch
For more information on SemVer, please visit http://semver.org/.
## License
```
twist-lib: Components for Adobe Twist
Copyright (c) 2018, Sandeep Gupta
https://sangupta.com/projects/twist-lib
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```