Skip to content

Commit

Permalink
Deploying to gh-pages from @ 01490e3 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
louiiuol committed Oct 13, 2024
1 parent 59d184e commit 766497e
Show file tree
Hide file tree
Showing 98 changed files with 3,640 additions and 14 deletions.
1 change: 1 addition & 0 deletions assets/ng-doc/indexes.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"breadcrumbs":["Components","Button"],"pageType":"guide","title":"Button","section":"","route":"components/button","content":"A button is an interface element that allows the user to perform a specific action when clicked."},{"breadcrumbs":["Changelog"],"pageType":"guide","title":"Changelog","section":"Architecture","route":"changelog","fragment":"architecture","content":" Generate angular app & link to github repository Set eslint/prettier configuration & workspace plugins Add deployment CI on github pages (available here) Configure tailwind (w/ custom colors & typography)"},{"breadcrumbs":["Changelog"],"pageType":"guide","title":"Changelog","section":"UI","route":"changelog","fragment":"ui","content":" Adding Application layout (header, router, footer) Adding initial HomePage"},{"breadcrumbs":["Changelog"],"pageType":"guide","title":"Changelog","section":"Components","route":"changelog","fragment":"components","content":" Icon component to render custom icon Icon Material component to display google icons Message component to display information with severity (info, warn, error ..) Notification center (display notification in the root component)"},{"breadcrumbs":["Changelog"],"pageType":"guide","title":"Changelog","section":"Core","route":"changelog","fragment":"core","content":" LocalStorageService NotificationService"},{"breadcrumbs":["Changelog"],"pageType":"guide","title":"Changelog","section":"Core","route":"changelog","fragment":"core","content":"Still in progress !"},{"breadcrumbs":["Components","Icon Material"],"pageType":"guide","title":"Icon Material","section":"","route":"components/icon-material","content":"Simple component to display an icon from material-symbols-outlined font."},{"breadcrumbs":["Components","Icon Material"],"pageType":"guide","title":"Icon Material","section":"","route":"components/icon-material","content":"Refer to the material-symbols-outlined font for the list of available icons.https://fonts.google.com/icons"},{"breadcrumbs":["Components","Icon Material"],"pageType":"guide","title":"Icon Material","section":"Pre requirements","route":"components/icon-material","fragment":"pre-requirements","content":"In order to use this component in your application, you must follow these steps:"},{"breadcrumbs":["Components","Icon Material"],"pageType":"guide","title":"Icon Material","section":"Adding Google font","route":"components/icon-material","fragment":"adding-google-font","content":"Insert the following script in your index.html or angular.json file."},{"breadcrumbs":["Components","Icon Material"],"pageType":"guide","title":"Icon Material","section":"Adding Font variation","route":"components/icon-material","fragment":"adding-font-variation","content":"Simply add this selector to your style.scss file. Adapt this settings to match desired styling. Check https://fonts.google.com/icons options for more information."},{"breadcrumbs":["Components","Icon Material"],"pageType":"guide","title":"Icon Material","section":"That's it 🎉","route":"components/icon-material","fragment":"thats-it-","content":"You can now start importing this component in your application !"},{"breadcrumbs":["Components","Icon"],"pageType":"guide","title":"Icon","section":"","route":"components/icon","content":"Simple component to display an icon as SVG tag from an svg file located in your assets/icons folder."},{"breadcrumbs":["Components","Icon"],"pageType":"guide","title":"Icon","section":"Pre requirements","route":"components/icon","fragment":"pre-requirements","content":"In order to use this component in your application, you must follow these steps:"},{"breadcrumbs":["Components","Icon"],"pageType":"guide","title":"Icon","section":"Create assets/icons folder","route":"components/icon","fragment":"create-assetsicons-folder","content":"In this folder, you can add all SVG required for your UI. You can also creates sub-folders but be aware, you'll need to format name as folderName/fileName."},{"breadcrumbs":["Components","Icon"],"pageType":"guide","title":"Icon","section":"Create assets/icons folder","route":"components/icon","fragment":"create-assetsicons-folder","content":"Note: With this component, you can control the fill of the SVG by adding some color of the component (works by inheritance)."},{"breadcrumbs":["Components","Icon"],"pageType":"guide","title":"Icon","section":"Import FileService","route":"components/icon","fragment":"import-fileservice","content":"This service helps working with files in general but this component requires getSVG() method. Simply copy paste this service or get isolated method."},{"breadcrumbs":["Components","Icon"],"pageType":"guide","title":"Icon","section":"That's it 🎉","route":"components/icon","fragment":"thats-it-","content":"You can now start importing this component in your application !"},{"breadcrumbs":["Components","Icon"],"pageType":"guide","title":"Icon","section":"That's it 🎉","route":"components/icon","fragment":"thats-it-","content":"Ensure that the SVG files in the assets/icons folder are properly named and formatted.The name input should match the file name of the SVG without the .svg extension."},{"breadcrumbs":["Components","Icon"],"pageType":"guide","title":"Icon","section":"That's it 🎉","route":"components/icon","fragment":"thats-it-","content":"By following these guidelines, you can effectively use the lib-icon component in your Angular application."},{"breadcrumbs":["Todo"],"pageType":"guide","title":"Todo","section":"Current development ⏰","route":"todo","fragment":"current-development-","content":"Tasks on development scope (more tasks can be found in this repository using TODO Tree -vscode extensions)"},{"breadcrumbs":["Todo"],"pageType":"guide","title":"Todo","section":"modules","route":"todo","fragment":"modules","content":" Platform Dialog Http request"},{"breadcrumbs":["Todo"],"pageType":"guide","title":"Todo","section":"directives","route":"todo","fragment":"directives","content":" Match Media File value accessor"},{"breadcrumbs":["Todo"],"pageType":"guide","title":"Todo","section":"guards","route":"todo","fragment":"guards","content":" Can deactivate"},{"breadcrumbs":["Todo"],"pageType":"guide","title":"Todo","section":"functions","route":"todo","fragment":"functions","content":" Capitalize Clean dash-to-camel-case"},{"breadcrumbs":["Todo"],"pageType":"guide","title":"Todo","section":"Pipes","route":"todo","fragment":"pipes","content":" Trust Html Trust URL Since"},{"breadcrumbs":["Todo"],"pageType":"guide","title":"Todo","section":"UI","route":"todo","fragment":"ui","content":" NotFoundPage ComponentsPage ServicesPage ModulesPage"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Angular Web User Interface 🎨","route":"get-started","fragment":"angular-web-user-interface-","content":"Angular library of components, services & patterns easing development of user interfaces. This is not a framework, nor a cdk, nut simply a collection of components following best practices in angular web development."},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Angular Web User Interface 🎨","route":"get-started","fragment":"angular-web-user-interface-","content":"This repository was created as a model for creating actual application. Feel free to use take any components you want 🙌"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"Dependency"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"version"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"@angular/core"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"^18.2.0"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"eslint"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"8.57.0"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"jest"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"^29.7.0"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"rxjs"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"~7.8.0"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"tailwind"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"^3.4.13"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"typescript"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"~5.5.2"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Built with 🏗️","route":"get-started","fragment":"built-with-️","content":"More dependencies can be found inside package.json."},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"This project contains multiple scripts. Remember to first run npm i in order to load required dependencies. Then you can run any of the scripts below:"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"Script"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"Description"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"npm run start"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"Serves application locally to "},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"https://localhost:4200"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"npm run build"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"Builds application in production mode to "},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"dist/ngx-lib/browser"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"npm run watch"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"Builds application in development mode and watch for file change"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"npm run test"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"Launch unit tests with Jest runner"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"npm run test:watch"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"Launch unit tests and watch for files change"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"npm run lint"},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Get Started 🚀","route":"get-started","fragment":"get-started-","content":"Lint repository with eslint & prettier."},{"breadcrumbs":["Welcome"],"pageType":"guide","title":"Welcome","section":"Versions 🔖","route":"get-started","fragment":"versions-","content":"A complete changelog can be found in dedicated markdown. Which resume current progress. You can also found what is in the current development inside TODO markdown."}]
1 change: 1 addition & 0 deletions assets/ng-doc/keywords.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"*IconPage":{"title":"Icon","path":"components/icon","type":"link"},"*IconPage#pre-requirements":{"title":"Icon [Pre requirements]","path":"components/icon#pre-requirements","type":"link"},"*IconPage#create-assetsicons-folder":{"title":"Icon [Create assets/icons folder]","path":"components/icon#create-assetsicons-folder","type":"link"},"*IconPage#import-fileservice":{"title":"Icon [Import FileService]","path":"components/icon#import-fileservice","type":"link"},"*IconPage#thats-it-":{"title":"Icon [That's it 🎉]","path":"components/icon#thats-it-","type":"link"},"*IconPage#playground-️":{"title":"Icon [Playground 🕹️]","path":"components/icon#playground-️","type":"link"}}
7 changes: 7 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/arrow-left.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/arrow-right.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/at-sign.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/check.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/chevron-right.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/chevrons-right.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/code.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/copy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/edit-2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/external-link.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/home.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/info.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/link-2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/ng-doc/ui-kit/icons/16/maximize.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/menu.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/minus.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions assets/ng-doc/ui-kit/icons/16/search.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 766497e

Please sign in to comment.