Skip to content

Commit

Permalink
,
Browse files Browse the repository at this point in the history
  • Loading branch information
radogado committed Apr 29, 2023
1 parent 84f3743 commit 85515cd
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 34 deletions.
55 changes: 22 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,41 @@
# niui: mostly native front-end library

A lightweight UI library leveraging browsers' built-in capabilities, with powerful customisation.
# niui is a lightweight, powerful and accessible UI library

To use niui, get [niui.min.css](https://radogado.github.io/niui/dist/niui.min.css), [niui.min.js](https://radogado.github.io/niui/dist/niui.min.js) and [index.html](https://radogado.github.io/niui/dist/index.html) and edit the latter. Or import the ES module js/niui.js. Check the [homepage](https://radogado.github.io/niui/) for details.

---

## Demo pages (reimplemented real world examples)

[WordPress theme](http://rado.bg), [Microsoft](https://radogado.github.io/niui/demos/microsoft/), [Imperial Innovations](https://radogado.github.io/niui/demos/imperialinnovations/), [Pebble homepage](https://radogado.github.io/niui/demos/pebble/), [Seat 61](https://radogado.github.io/niui/demos/seat61/), [JetBlue](https://radogado.github.io/niui/demos/jetblue/), [Mitsubishi Regional Jet](https://radogado.github.io/niui/demos/mrj/), [MUBI](https://radogado.github.io/niui/demos/mubi/), [SWISS](https://radogado.github.io/niui/demos/swiss/), [Mapbox](https://radogado.github.io/niui/demos/mapbox/), [Airbnb](https://radogado.github.io/niui/demos/airbnb/), [GOV.UK](https://radogado.github.io/niui/demos/gov.uk/), [Google Design](https://radogado.github.io/niui/demos/google-design/), [Daring Fireball](https://radogado.github.io/niui/demos/daringfireball/), [Vitsœ](https://radogado.github.io/niui/demos/vitsoe/), [Apple](https://radogado.github.io/niui/demos/apple/), [Brand Union](https://radogado.github.io/niui/demos/brandunion/), [Tesla](https://radogado.github.io/niui/demos/tesla/), [Amnesty](https://radogado.github.io/niui/demos/amnesty/), [Stripe](https://radogado.github.io/niui/demos/stripe/), [Star Wars](https://radogado.github.io/niui/demos/starwars/), [Norwegian](https://radogado.github.io/niui/demos/norwegian/), [David Bowie Is (Japan)](https://radogado.github.io/niui/demos/davidbowieis/), [Uncharted: The Lost Legacy](https://radogado.github.io/niui/demos/uncharted-the-lost-legacy/), [Seehotel Jägerwirt](https://radogado.github.io/niui/demos/seehotel-jaegerwirt/), [Truphone](https://radogado.github.io/niui/demos/truphone/), [Pixel Pioneers](https://radogado.github.io/niui/demos/pixelpioneers/), [Apex](https://radogado.github.io/niui/demos/apex/), [Loco2](https://radogado.github.io/niui/demos/loco2/), [VI.nl](https://radogado.github.io/niui/demos/vi.nl/), [Nikon D850](https://radogado.github.io/niui/demos/nikon-d850/), [Enoden](https://radogado.github.io/niui/demos/enoden/), [Tuts+](https://radogado.github.io/niui/demos/tutsplus/), [Hasselblad Chinese](https://radogado.github.io/niui/demos/hasselblad/), [CNN Travel](https://radogado.github.io/niui/demos/cnn-travel/), [Postbank](https://radogado.github.io/niui/demos/postbank/), [To Make a Film](https://radogado.github.io/niui/demos/tomakeafilm/), [Oslo](https://radogado.github.io/niui/demos/oslo/)

---

- BEM class names
- Prefixed BEM class names
- Semantic structure
- Unbreakable, flexible, responsive [grid](https://radogado.github.io/niui/#grid) with alignment, embedding, borders option.
- Baseline-aligned [typography](https://radogado.github.io/niui/#typography), quote block, drop caps.
- Embeddable grid and elements. Support for multiple modals, nested carousels, nested accordions etc
- Built around edge cases (overflowing headlines, images etc)
- Built for edge cases (overflowing headlines, images etc)
- Flat default style without rounded edges, shadows etc
- Optinal rounded edges, border, shadow via Sass variables
- Optional rounded edges, border, shadow via Sass variables
- Dark theme
- Semantic structure
- [Dynamic components](https://radogado.github.io/niui/#dynamic-components), dynamically initialised by MutationObserver
- (Mobile) [navigation](https://radogado.github.io/niui/#nav). Drop-down nav: Touch-first, CSS-only, JS enhanced, 1-3 levels, responsive, label/link items support
- [Buttons](https://radogado.github.io/niui/#buttons) with group container for proper line wrap
- [Modal windows](https://radogado.github.io/niui/#modal) with multiple instances, supporting iPhone Safari toolbars
- Native [carousel](https://radogado.github.io/niui/#carousel), swipeable on mobile and desktop, vertical and full window options, carousel inside carousel, auto height option
- [Lightbox gallery](https://radogado.github.io/niui/#lightbox) supporting huge galleries and click to zoom. Can be opened automatically by URI page#lightbox_id. Video in lightbox. Inline lightboxes switchable to full screen.
- [Dynamic components](https://radogado.github.io/niui/#dynamic-components), initialised by MutationObserver
- (Mobile) [navigation](https://radogado.github.io/niui/#nav) – horizontal, vertical, scrolling. Drop-down nav: Touch-first, CSS-only, JS enhanced, 1-3 levels, responsive, label/link items support
- [Buttons](https://radogado.github.io/niui/#buttons) with group container for proper line wrap and optional ripple effect
- [Modal windows](https://radogado.github.io/niui/#modal) using the Dialog element with many options – shadow, blur, multiple data sources
- Native [carousel](https://radogado.github.io/niui/#carousel), swipeable on mobile and desktop, vertical and full window options, carousel inside carousel, auto height option etc
- [Lightbox gallery](https://radogado.github.io/niui/#lightbox)
- [Tabs](https://radogado.github.io/niui/#tabs)
- [Tooltips](https://radogado.github.io/niui/#tooltip) with full HTML content
- Nested ordered [lists](https://radogado.github.io/niui/#lists)
- [Forms](https://radogado.github.io/niui/#forms) with validation, customisation and accessibility. Rich select available.
- [Accordions](https://radogado.github.io/niui/#accordion) + Grid with inline popups
- [Tooltips](https://radogado.github.io/niui/#tooltip) with full HTML content, auto positioning and unaffected by overflow: hidden
- Nested (un)ordered [lists](https://radogado.github.io/niui/#lists)
- [Forms](https://radogado.github.io/niui/#forms) with validation, customisation and accessibility. Range input, file input, mandatory fields, optional fieldsets, rich select.
- [Accordions](https://radogado.github.io/niui/#accordion) – nested, grouped, in a grid
- [Cards](https://radogado.github.io/niui/#cards)
- [Tables](https://radogado.github.io/niui/#tables) accessible on narrow screens by scrolling; sortable.
- [Aspect ratio](https://radogado.github.io/niui/#aspect-ratio) image container
- [Masonry](https://radogado.github.io/niui/#masonry) CSS-only (vertical track only)
- [Tables](https://radogado.github.io/niui/#tables) accessible on narrow screens by scrolling; optionally sortable.
- [Aspect ratio](https://radogado.github.io/niui/#aspect-ratio) for image containers
- [Masonry](https://radogado.github.io/niui/#masonry) (vertical track only)
- [Parallax scrolling](https://radogado.github.io/niui/#parallax)
- [Fixed background](https://radogado.github.io/niui/#fixed-background)
- [WordPress theme](https://radogado.github.io/niui/niui-wp.zip) with lightbox gallery
- [WordPress theme](https://radogado.github.io/niui/niui-wp.zip) with lightbox gallery (Classic Editor only)
- [Notification bar](https://radogado.github.io/niui/#notifications)
- Click to [copy to clipboard](https://radogado.github.io/niui/#copy)
- RTL layout ready
- 14 KB first view CSS + optional 12 KB JS (combined, minified, macOS gzip)
- Accessible by keyboard
- 14 KB first view CSS + optional 12 KB JS (combined, minified, gzipped)
- Functional without JS and accessible without CSS
- Seamless transition from CSS-only to JS-enhanced layout
- Seamless transition from CSS-only to JS enhancement
- No dependencies
- All components accessible by keyboard

© 2014-2023 [rado.bg](http://rado.bg)

Expand Down
9 changes: 8 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,13 @@ <h4>Or install with NPM and include the niui files</h4>
<div class=code>
<pre><code class="language-js">import nui from './node_modules/niui-npm/js/niui.js';</code></pre>
</div>

<p>To costomise the bundle, remove anything unnecessary from <b>components/</b> and run</p>
<div class=code>
<pre><code class="language-js">npm i --legacy-peer-deps
./build.sh</code></pre>
</div>

<!-- <h3>Lite version available at <a href=dist/niui-lite.min.css download>niui-lite.min.css</a>, <a href=dist/niui-lite.min.js download>niui-lite.min.js</a> without the following components:</h3>
<ul>
<li>Carousel</li>
Expand Down Expand Up @@ -1082,7 +1089,7 @@ <h2>Rich select</h2>
<div class="n-row">
<div class="_1/1">
<h2 class="section-title">Typography</h2>
<p>For niui typography features like baseline alignment, wrap the below elements inside an <b>.n-type</b> container</p>
<p>For niui typography features like baseline alignment, wrap the below elements inside an <b>.n-type</b> container.</p>
</div>
<div class="_1/3">
<h3>Headlines</h3>
Expand Down

0 comments on commit 85515cd

Please sign in to comment.