aligorji / ngx-fomantic-ui

🚀 An Angular 10 library for Fomantic UI without jQuery. ⚒️ Based on @edcarroll's ng2-semantic-ui.

ngx-fomantic-ui

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

Introduction

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

Note that only Fomantic 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.

This is a fork of edcarroll's ng2-semantic-ui, updated to Angular 7 and Fomantic UI.

Installation & Usage

See the Documentation for installation instructions and extensive examples.

Dependencies

• Angular (^10.0.0)
• Fomantic UI CSS (^2.7.4) (jQuery is not required)

Component Support

Icon	Description
✅	Component supported by ngx-fomantic-ui.
🚀	Fomantic UI plugin supported by ngx-fomantic-ui (not in Fomantic UI Core).
☑️	Component supported natively by Fomantic 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
			✅ Toast
			✅ Transition

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

Running Documentation Website on Docker

The ngx-fomantic-ui website sample project can run as a docker container. In order to run the website on docker, use the following commands (run commands from the repo's root folder):

• docker build -t ngx-fomantic-ui-docs:latest . - building the ngx-fomantic-ui website image
• docker run -p <host-port>:4200 ngx-fomantic-ui-docs:latest - starting the container, listening on for your choice.

The container will run the documentation app with the script docker:serve:docs with 0.0.0.0 host support.

• Saving the image for later offline usage is available by building the container and then using docker save ngx-fomantic-ui-docs:latest > <tar-name>.tar and loading it afterwards with sudo docker load < <tar-name>.tar.

tested on ubuntu 18.04.2 with Docker 18.09.6

Credits and License

• MIT © Edward Carroll