Skip to content

Latest commit

 

History

History
117 lines (93 loc) · 7.73 KB

README.md

File metadata and controls

117 lines (93 loc) · 7.73 KB

Gitter Travis CI npm monthly downloads

Semantic UI Angular Integrations, written in pure Angular - no JQuery required.

Important:

This is an intended endeavour to upgrade the awesome ng2-semantic-ui to later versions of Angular. For time reasons, the code is only tested for successful compilation of the library and demo page. This code is provided absolutely free of warranty. If you find a bug, feel free to contribute a fix.

Angular Package Branch
Angular 9 9.x.x angular-9
Angular 10 10.x.x angular-10
Angular 11 11.x.x angular-11
Angular 12 12.x.x angular-12
Angular 13 13.x.x angular-13
Angular 14 14.x.x angular-14
Angular 15 15.x.x angular-15
Angular 16 16.x.x angular-16

Introduction

Angular and jQuery don't go together - this is the fundamental principal of this library. It provides Angular component versions of the Semantic UI modules, so that you don't need to add jQuery to your app.

Note that only Semantic UI elements that use jQuery are recreated here - those written purely in CSS aren't included as they can be used in Angular apps already.

Installation & Usage

See the Documentation for installation instructions and extensive examples.

Dependencies

This package is upgraded to each respective major Angular version. Besides successful building of the library and demo page, no extensive testing is done.

  • Angular (^9.0.0 or check corresponding branches / versions on NPM)
  • Semantic UI CSS (^2.3.1) (jQuery is not required)

Component Support

Icon Description
Component supported by ng2-semantic-ui.
🚀 Semantic UI plugin supported by ng2-semantic-ui (not in Semantic UI Core).
☑️ Component supported natively by Semantic UI (CSS only).
Component currently unavailable.
🚫 Component not applicable to Angular.
Elements Collections Views Modules Behaviors
☑️ Button ☑️ Breadcrumb ☑️ Advertisment ✅ Accordion 🚫 API
☑️ Container ☑️ Form ☑️ Card ✅ Checkbox 🚫 Form Validation
☑️ Divider ☑️ Grid ☑️ Comment 🚀 Collapse 🚀 Localization
☑️ Flag ☑️ Menu ☑️ Feed 🚀 Datepicker ❌ Visibiltiy
☑️ Header ✅ Message ☑️ Item ✅ Dimmer
☑️ Icon 🚀 Pagination ☑️ Statistic ✅ Dropdown
☑️ Image ☑️ Table ❌ Embed
☑️ Input ✅ Modal
☑️ Label ✅ Popup
☑️ List ✅ Progress
☑️ Loader ✅ Rating
☑️ Rail ✅ Search
☑️ Reveal ❌ Shape
☑️ Segment ✅ Sidebar
☑️ Step ❌ Sticky
✅ Tab
✅ Transition

Want to help?

Want to file a bug, contribute some code, or improve documentation? Great! Please read the contributing guidelines to get going.

Development

To generate all library files:

$ npm run lib:compile
# use lib:compile:w to watch for changes

To run the demo app:

$ npm run demo:serve

Testing

To run the unit tests suite:

$ npm run test

License

MIT © Edward Carroll MIT © Nikita Fuchs