\r\n
Current Version
\r\n
React 16.7.0 and PrimeReact 3.0.0
\r\n\r\n
Getting Started
\r\n
Avalon is an application template for React based on the popular create-react-app that allows\r\n creating React apps with no configuration. To get started extract the contents of the zip bundle and install the dependencies\r\n with npm or yarn.
\r\n
\r\n{\r\n`npm install\r\n`}\r\n\r\n\r\n or\r\n\r\n
\r\n{\r\n`yarn\r\n`}\r\n\r\n\r\n
Next step is running the application using the start script and navigate to http://localhost:3000/ to view the application.\r\n That is it, you may now start with the development of your application using the Avalon template.
\r\n\r\n
\r\n{\r\n`npm start\r\n`}\r\n\r\n\r\n or\r\n\r\n
\r\n{\r\n`yarn start\r\n`}\r\n\r\n\r\n
React Scripts
\r\n
Following commands are derived from create-app-app.
\r\n
\r\n{\r\n`\"npm start\" or \"yarn start\": Starts the development server\r\n\"npm test\" or \"yarn test\": Runs the tests.\r\n\"npm run build\" or \"yarn run build\": Creates a production build.\r\n`}\r\n\r\n\r\n
Dependencies
\r\n
Only required dependencies are PrimeReact, PrimeIcons PrimeFlex where optional dependencies exist to enable certain components in PrimeReact such as Google Maps.
\r\n\r\n
\r\n{\r\n`\"primereact\": \"^2.0.0-beta.8\", //required: PrimeReact components\r\n\"primeflex\": \"^1.0.0-rc.1\", //required: Layout\r\n\"primeicons\": \"^1.0.0-beta.10\", //required: Component Icons\r\n\"react-router-dom\": \"^4.2.2\" //optional: Router\r\n`\r\n}\r\n\r\n\r\n
Structure
\r\n
Avalon consists of 3 main parts; the application layout, layout resources and theme resources for PrimeReact components. App.js inside src folder is the main component containing the template for the base layout\r\n whereas required resources for the layout are placed inside the public/assets/layout folder and similarly theme resources are inside public/assets/theme folder.\r\n
\r\n\r\n
Template
\r\n
Main layout is the JSX of the App.js, it is divided into a couple of child components such as topbar, profile, menu and footer. Here is render method of the\r\n App.js component that implements the logic such as menu state, layout modes and so on.\r\n
\r\n\r\n
\r\n{\r\n`render() {\r\n let layoutClassName = classNames('layout-wrapper', {\r\n 'menu-layout-static': this.state.layoutMode !== 'overlay',\r\n 'menu-layout-overlay': this.state.layoutMode === 'overlay',\r\n 'layout-menu-overlay-active': this.state.overlayMenuActive,\r\n 'menu-layout-slim': this.state.layoutMode === 'slim',\r\n 'menu-layout-horizontal': this.state.layoutMode === 'horizontal',\r\n 'layout-menu-static-inactive': this.state.staticMenuDesktopInactive,\r\n 'layout-menu-static-active': this.state.staticMenuMobileActive\r\n });\r\n let menuClassName = classNames('layout-menu-container', {'layout-menu-dark': this.state.darkMenu});\r\n \r\n return (\r\n \r\n
\r\n
\r\n\r\n
\r\n
this.layoutMenuScroller = el} style={{height: '100%'}}>\r\n \r\n {(this.state.profileMode === 'inline' && this.state.layoutMode !== 'horizontal') &&
}\r\n
\r\n
\r\n
\r\n \r\n
\r\n {this.props.children || }\r\n
\r\n \r\n
\r\n \r\n
\r\n
\r\n
\r\n\r\n
Menu
\r\n
Menu is a separate component defined in AppMenu.js file based on PrimeReact MenuModel API. In order to define the menuitems,\r\n navigate to createMenu() method App.js file and define your own model as a nested structure. Here is the menu component from the demo application.\r\n Notice that menu object is bound to the model property of AppMenu component as shown above.
\r\n\r\n
\r\n{\r\n`createMenu() {\r\n this.menu = [\r\n {\r\n label: 'Bootstrap Version', icon: 'fa fa-fw fa-tags',\r\n items: [\r\n {label: 'Bootstrap v3', icon: 'fa fa-fw fa-tag', command: () => this.changeVersion('v3')},\r\n {label: 'Bootstrap v4', icon: 'fa fa-fw fa-tag', command: () => this.changeVersion('v4')}\r\n ]\r\n },\r\n {label: 'Dashboard', icon: 'fa fa-fw fa-home', command: () => { window.location.hash=\"/\"}},\r\n {\r\n label: 'Customization', icon: 'fa fa-fw fa-bars' ,badge: '8',\r\n items: [\r\n {label: 'Static Menu', icon: 'fa fa-fw fa-bars', command: () => this.setState({layoutMode: 'static'}) },\r\n {label: 'Overlay Menu', icon: 'fa fa-fw fa-bars', command: () => this.setState({layoutMode: 'overlay'}) },\r\n {label: 'Slim Menu', icon: 'fa fa-fw fa-bars', command: () => this.setState({layoutMode: 'slim'}) },\r\n {label: 'Horizontal Menu', icon: 'fa fa-fw fa-bars', command: () => this.setState({layoutMode: 'horizontal'}) },\r\n {label: 'Inline Profile', icon: 'fa fa-sun-o fa-fw', command: () => this.setState({profileMode: 'inline'}) },\r\n {label: 'Top Profile', icon: 'fa fa-moon-o fa-fw', command: () => this.setState({profileMode: 'top'}) },\r\n {label: 'Light Menu', icon: 'fa fa-sun-o fa-fw', command: () => this.setState({darkMenu: false}) },\r\n {label: 'Dark Menu', icon: 'fa fa-moon-o fa-fw', command: () => this.setState({darkMenu: true}) }\r\n ]\r\n },\r\n {\r\n label: 'Layout Colors', icon: 'fa fa-fw fa-magic',\r\n items: [\r\n {\r\n label: 'Flat', \r\n icon: 'fa fa-fw fa-circle',\r\n items: [\r\n {label: 'Blue', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('blue')}},\r\n {label: 'Purple', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('purple')}},\r\n {label: 'Cyan', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('cyan')}},\r\n {label: 'Indigo', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('indigo')}},\r\n {label: 'Teal', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('teal')}},\r\n {label: 'Pink', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('pink')}},\r\n {label: 'Lime', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('lime')}},\r\n {label: 'Green', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('green')}},\r\n {label: 'Amber', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('amber')}},\r\n {label: 'Dark Grey', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('darkgrey')}},\r\n ]\r\n },\r\n {\r\n label: 'Special', \r\n icon: 'fa fa-fw fa-fire',\r\n items: [\r\n {label: 'Influenza', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('influenza', true)}},\r\n {label: 'Suzy', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('suzy', true)}},\r\n {label: 'Calm', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('calm', true)}},\r\n {label: 'Crimson', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('crimson', true)}},\r\n {label: 'Night', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('night', true)}},\r\n {label: 'Skyling', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('skyline', true)}},\r\n {label: 'Sunkist', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('sunkist', true)}},\r\n {label: 'Little Leaf', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('littleleaf', true)}},\r\n {label: 'Joomla', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('joomla', true)}},\r\n {label: 'Firewatch', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeLayout('firewatch', true)}}\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n label: 'Themes', icon: 'fa fa-fw fa-paint-brush', badge: '5',\r\n items: [\r\n {label: 'Blue', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('blue')}},\r\n {label: 'Cyan', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('cyan')}},\r\n {label: 'Indigo', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('indigo')}},\r\n {label: 'Purple', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('purple')}},\r\n {label: 'Teal', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('teal')}},\r\n {label: 'Orange', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('orange')}},\r\n {label: 'Deep Purple', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('deeppurple')}},\r\n {label: 'Light Blue', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('lightblue')}},\r\n {label: 'Green', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('green')}},\r\n {label: 'Light Green', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('lightgreen')}},\r\n {label: 'Lime', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('lime')}},\r\n {label: 'Amber', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('amber')}},\r\n {label: 'Brown', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('brown')}},\r\n {label: 'Dark Grey', icon: 'fa fa-fw fa-paint-brush', command: (event) => {this.changeTheme('darkgrey')}},\r\n ]\r\n },\r\n {\r\n label: 'Components', icon: 'fa fa-fw fa-sitemap',\r\n items: [\r\n {label: 'Sample Page', icon: 'fa fa-fw fa-columns', command: () => { window.location.hash=\"/sample\"; }},\r\n {label: 'Forms', icon: 'fa fa-fw fa-code', command: () => { window.location.hash=\"/forms\"; }},\r\n {label: 'Data', icon: 'fa fa-fw fa-table', command: () => { window.location.hash=\"/data\"; }},\r\n {label: 'Panels', icon: 'fa fa-fw fa-list-alt', command: () => { window.location.hash=\"/panels\"; }},\r\n {label: 'Overlays', icon: 'fa fa-fw fa-square', command: () => { window.location.hash=\"/overlays\"; }},\r\n {label: 'Menus', icon: 'fa fa-fw fa-minus-square-o', command: () => { window.location.hash=\"/menus\"; }},\r\n {label: 'Messages', icon: 'fa fa-fw fa-circle-o-notch', command: () => { window.location.hash=\"/messages\"; }},\r\n {label: 'Charts', icon: 'fa fa-fw fa-area-chart', command: () => { window.location.hash=\"/charts\"; }},\r\n {label: 'Misc', icon: 'fa fa-fw fa-user-secret', command: () => { window.location.hash=\"/misc\"; }}\r\n ]\r\n },\r\n {\r\n label: 'Template Pages', icon: 'fa fa-fw fa-life-saver',\r\n items: [\r\n {label: 'Empty Page', icon: 'fa fa-fw fa-square-o', command: () => { window.location.hash=\"/empty\"; }},\r\n {label: 'Landing', icon: 'fa fa-fw fa-certificate', url: 'assets/pages/landing.html', target: '_blank'},\r\n {label: 'Login', icon: 'fa fa-fw fa-sign-in', url: 'assets/pages/login.html', target: '_blank'},\r\n {label: 'Error', icon: 'fa fa-fw fa-exclamation-circle', url: 'assets/pages/error.html', target: '_blank'},\r\n {label: 'Not Found', icon: 'fa fa-fw fa-times', url: 'assets/pages/notfound.html', target: '_blank'},\r\n {label: 'Access Denied', icon: 'fa fa-fw fa-exclamation-triangle', url: 'assets/pages/access.html', target: '_blank'}\r\n ]\r\n },\r\n {\r\n label: 'Menu Hierarchy', icon: 'fa fa-fw fa-gg',\r\n items: [\r\n {\r\n label: 'Submenu 1', icon: 'fa fa-fw fa-sign-in',\r\n items: [\r\n {\r\n label: 'Submenu 1.1', icon: 'fa fa-fw fa-sign-in',\r\n items: [\r\n {label: 'Submenu 1.1.1', icon: 'fa fa-fw fa-sign-in'},\r\n {label: 'Submenu 1.1.2', icon: 'fa fa-fw fa-sign-in'},\r\n {label: 'Submenu 1.1.3', icon: 'fa fa-fw fa-sign-in'},\r\n ]\r\n },\r\n {\r\n label: 'Submenu 1.2', icon: 'fa fa-fw fa-sign-in',\r\n items: [\r\n {label: 'Submenu 1.2.1', icon: 'fa fa-fw fa-sign-in'},\r\n {label: 'Submenu 1.2.2', icon: 'fa fa-fw fa-sign-in'}\r\n ]\r\n },\r\n ]\r\n },\r\n {\r\n label: 'Submenu 2', icon: 'fa fa-fw fa-sign-in',\r\n items: [\r\n {\r\n label: 'Submenu 2.1', icon: 'fa fa-fw fa-sign-in',\r\n items: [\r\n {label: 'Submenu 2.1.1', icon: 'fa fa-fw fa-sign-in'},\r\n {label: 'Submenu 2.1.2', icon: 'fa fa-fw fa-sign-in'},\r\n {label: 'Submenu 2.1.3', icon: 'fa fa-fw fa-sign-in'},\r\n ]\r\n },\r\n {\r\n label: 'Submenu 2.2', icon: 'fa fa-fw fa-sign-in',\r\n items: [\r\n {label: 'Submenu 2.2.1', icon: 'fa fa-fw fa-sign-in'},\r\n {label: 'Submenu 2.2.2', icon: 'fa fa-fw fa-sign-in'}\r\n ]\r\n },\r\n ]\r\n }\r\n ]\r\n },\r\n {label: 'Utils', icon: 'fa fa-fw fa-wrench', command: () => { window.location.hash=\"/utils\"; }},\r\n {label: 'Documentation', icon: 'fa fa-fw fa-book', command: () => { window.location.hash=\"/documentation\"; }}\r\n ];\r\n}\r\n \r\n`}\r\n\r\n\r\n
Bootstrap 3 and 4
\r\n
Avalon offers bootstrap 3 and 4 styling options for both the theme and layout. Default one is bootstrap 4 and adding \"-v4\" suffix to the files you use to enables V4 support such as layout-blue-v4.css for the layout and theme-blue-v4.css for the theme.\r\n Note that there is no dependency on Bootstrap since Avalon provides a theme on Bootstrap styling only without using Bootstrap directly. However it is\r\n perfectly compatible with Bootstrap as they share the same look and feel.\r\n
\r\n\r\n
Theme and Layout SASS
\r\n
Avalon provides 30 PrimeReact themes out of the box, setup of a theme is simple as including the css of theme to your application. All themes are located inside are located inside assets/theme folder.
\r\n\r\n
\r\n - theme-amber
\r\n - theme-amber-v4
\r\n - theme-blue
\r\n - theme-blue-v4
\r\n - theme-brown
\r\n - theme-brown-v4
\r\n - theme-cyan
\r\n - theme-cyan-v4
\r\n - theme-darkgrey
\r\n - theme-darkgrey-4
\r\n - theme-deeppurple
\r\n - theme-green
\r\n - theme-green-v4
\r\n - theme-indigo
\r\n - theme-indigo-v4
\r\n - theme-lightblue
\r\n - theme-lightblue-v4
\r\n - theme-lightgreen
\r\n - theme-lightgreen-v4
\r\n - theme-lime
\r\n - theme-lime-v4
\r\n - theme-orange
\r\n - theme-orange-v4
\r\n - theme-pink
\r\n - theme-pink-v4
\r\n - theme-purple
\r\n - theme-purple-v4
\r\n - theme-teal
\r\n - theme-teal-v4
\r\n
\r\n\r\n
A custom theme can be developed by the following steps.
\r\n
\r\n - Choose a custom theme name such as theme-myown.
\r\n - Create a file named theme-myown.scss under public/assets/theme folder.
\r\n - Define the variables listed below and import the ../sass/theme/_theme.scss or ../sass/theme-v4/_theme.scss file depending on Bootstrap version.
\r\n - Build the scss to generate css
\r\n - Include the generated theme.css in your application.
\r\n
\r\n\r\n
Here are the variables required to create a theme.
\r\n\r\n
Bootstrap 3\r\n
\r\n{\r\n`$primaryColor:#337ab7;\r\n$primaryTextColor:#ffffff;\r\n$inputFocusBorderColor:#66afe9;\r\n$highlightBgColor:#337ab7;\r\n$highlightTextColor:#ffffff;\r\n$headerBgColor:#f5f5f5;\r\n$headerHoverBgColor:#dcdcdc;\r\n$headerHoverBorderColor:#c4c4c4;\r\n$headerTextColor:#292B2C;\r\n$headerBorderColor:#dddddd;\r\n$headerIconColor:#999999;\r\n$headerIconHoverColor:#777777;\r\n$datableEvenRowBgColor:#f9f9f9;\r\n$datatableHoverBgColor:#f5f5f5;\r\n\r\n@import '../sass/theme/_theme';\r\n`\r\n}\r\n\r\n\r\n
Bootstrap 4\r\n
\r\n{\r\n`$primaryColor:#007bff;\r\n$primaryTextColor:#ffffff;\r\n$inputFocusBorderColor:#80bdff;\r\n$inputFocusBorderShadowColor:rgba(0,123,255,.25);\r\n$highlightBgColor:#007bff;\r\n$highlightTextColor:#ffffff;\r\n$headerBgColor:#f5f5f5;\r\n$headerHoverBgColor:#dcdcdc;\r\n$headerHoverBorderColor:#c4c4c4;\r\n$headerTextColor:#292B2C;\r\n$headerBorderColor:#dddddd;\r\n$headerIconColor:#999999;\r\n$headerIconHoverColor:#bd9090;\r\n$datableEvenRowBgColor:#f9f9f9;\r\n$datatableHoverBgColor:#f5f5f5;\r\n$buttonTextColor:#ffffff;\r\n$buttonBgColor:#007bff;\r\n$buttonBorderColor:#007bff;\r\n$buttonHoverBgColor:#0069d9;\r\n$buttonHoverBorderColor:#0062cc;\r\n$buttonActiveBgColor:#0062cc;\r\n$buttonActiveBorderColor:#005cbf;\r\n$buttonFocusBorderShadow:rgba(0,123,255,.5);\r\n\r\n@import '../sass/theme-v4/_theme';\r\n`\r\n}\r\n\r\n\r\n
An example sass command to compile the css would be;
\r\n\r\n
\r\nsass public/assets/theme/theme-myown.scss public/assets/theme/theme-myown.css\r\n
\r\n\r\n
Watch mode is handy to avoid compiling everytime when a change is made, instead use the following command\r\n so that sass generates the file whenever you make a customization. This builds all css files whenever a change is made to any scss file.
\r\n
\r\nsass -w src/assets/ --sourcemap=none\r\n
\r\n\r\n
Same can also be applied to layout itself;
\r\n
\r\n - Choose a layout name such as layout-myown.
\r\n - Create an empty file named layout-myown.scss inside assets/layout/css folder.
\r\n - Define the variables listed below and import the ../sass/layout/_layout.scss or ../sass/layout-v4/_layout.scss file depending on the Bootstrap version.
\r\n - Build the scss to generate css
\r\n - Serve the css by importing it using a link tag or a bundler.
\r\n
\r\n\r\n
Here are the variables required to create a layout.
\r\n\r\n
\r\n{\r\n`$topbarLeftGradientStartBgColor:#ff8f00;\r\n$topbarLeftGradientEndBgColor:#ffb300;\r\n$topbarRightGradientStartBgColor:#ff8f00;\r\n$topbarRightGradientEndBgColor:#ffb300;\r\n$topbarTextColor:#ffffff;\r\n$menuGradientStartBgColor:#ffffff;\r\n$menuGradientEndBgColor:#ffffff;\r\n$menuitemHoverBgColor:#e8e8e8;\r\n$menuitemActiveColor: #ff8f00;\r\n$menuitemActiveBgColor:#e8e8e8;\r\n$menuButtonBgColor:#ffffff;\r\n$menuButtonColor:#ff6f00;\r\n$badgeBgColor:#3eb839;\r\n$badgeColor:#ffffff;\r\n$darkMenuGradientStartBgColor:#363a41;\r\n$darkMenuGradientEndBgColor:#363a41;\r\n$darkMenuHoverBgColor:#4a4d54;\r\n$darkMenuMenuitemColor:#ffffff;\r\n$darkMenuMenuitemActiveColor:#ffe57f;\r\n$darkMenuMenuitemActiveBgColor:#282b30;\r\n\r\n//Bootstrap V3\r\n@import '../../sass/layout/_layout';\r\n\r\n//or\r\n\r\n//Bootstrap V4\r\n@import '../../sass/layout-v4/_layout';\r\n`\r\n}\r\n\r\n\r\n
Common SASS Variables
\r\n
In case you'd like to customize common variables, the _common.scss and _common-v4.scss under sass variables folder is where the core variables (e.g. font size, paddings) for the layout are defined.
\r\n\r\n
sass/variables/_common.scss
\r\n
\r\n{\r\n`$fontFamily:\"Helvetica Neue\",Helvetica,Arial,sans-serif;\r\n$fontSize:14px;\r\n$textColor:#212529;\r\n$textSecondaryColor:#777777;\r\n$borderRadius:4px;\r\n$dividerColor:#e5e5e5;\r\n$transitionDuration:.3s;\r\n$disabledBgColor:#eeeeee;\r\n\r\n/* Predefined Colors */\r\n$lightestGray:#f5f5f5;\r\n$lightGray:#cccccc;\r\n$gray:#999999;\r\n$darkGray:#777777;\r\n$white:#ffffff;\r\n\r\n$blue:#337ab7;\r\n$purple:#9189fd;\r\n$orange:#ffbf79;\r\n$lightBlue:#8dc8ff;\r\n$pink:#f790c8;\r\n\r\n$green:#3e9018;\r\n$red:#da2f31;\r\n$orange:#ffb200;\r\n$teal:#599597;\r\n$black:#000000;\r\n$yellow:#ffd644;\r\n\r\n$inputInvalidBorderColor:#fa8a28;\r\n$inputInvalidBgColor:#ffffff;\r\n`\r\n}\r\n\r\n\r\n
sass/variables/_common-v4.scss
\r\n
\r\n{\r\n`$fontFamily:-apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\";\r\n$fontSize:14px;\r\n$textColor:#292B2C;\r\n$textSecondaryColor:#777777;\r\n$borderRadius:4px;\r\n$dividerColor:#e5e5e5;\r\n$transitionDuration:.3s;\r\n$disabledBgColor:#eeeeee;\r\n\r\n/* Predefined Colors */\r\n$lightestGray:#f5f5f5;\r\n$lightGray:#cccccc;\r\n$gray:#999999;\r\n$darkGray:#777777;\r\n$white:#ffffff;\r\n\r\n$blue:#007bff;\r\n$purple:#9189fd;\r\n$orange:#ffbf79;\r\n$lightBlue:#8dc8ff;\r\n$pink:#f790c8;\r\n$indigo:#6610f2;\r\n$green:#3e9018;\r\n$red:#da2f31;\r\n$orange:#ffb200;\r\n$teal:#599597;\r\n$black:#000000;\r\n$yellow:#ffd644;\r\n\r\n\r\n$inputInvalidBorderColor:#fa8a28;\r\n$inputInvalidBgColor:#ffffff;\r\n`\r\n}\r\n\r\n\r\n
_variables.scss under layout and layout-v4 folder define the shared variables of the layout.
\r\n
\r\n{\r\n`@import '../variables/_common';\r\n\r\n$menuHoverBgColor:#f4f4f4;\r\n$bodyBgColor:#EEF2F6;\r\n`\r\n}\r\n\r\n
Similarly _variables.scss files inside theme and theme-v4 folders contain the shared variables of the PrimeReact theme.
\r\n
sass/theme/_variables.scss
\r\n
\r\n{\r\n`@import '../variables/common';\r\n\r\n/* Icons */\r\n$iconFontSize:14px;\r\n$iconWidth:16px;\r\n\r\n/* Error */\r\n$errorColor:#a94442;\r\n$disabledColor:#eeeeee;\r\n\r\n/* Invalid Input */\r\n$errorBorderColor:#fa8a28;\r\n\r\n/* Headers */\r\n$headerPadding:10px 15px;\r\n\r\n/* Contents */\r\n$contentPadding:15px;\r\n$contentBorderColor:#dddddd;\r\n$contentBgColor:#ffffff;\r\n$contentLineHeight:1.43;\r\n\r\n/* Forms */\r\n$inputBgColor:#ffffff;\r\n$inputPadding:6px 12px;\r\n$inputBorderColor:#cccccc;\r\n$inputHoverBorderColor:#cccccc;\r\n$inputTextColor:#495057;\r\n\r\n//groups\r\n$inputGroupBorderColor:#cccccc;\r\n$inputGroupBgColor:#ffffff;\r\n$inputGroupTextColor:$textColor;\r\n$inputGroupIconColor:$textSecondaryColor;\r\n$inputGroupAddonMinWidth:2*$fontSize;\r\n$checkboxWidth:20px;\r\n$checkboxHeight:20px;\r\n\r\n/* Buttons */\r\n$buttonPadding: 0.429em 0.857em;\r\n$buttonIconOnlyPadding: 0.429em;\r\n$buttonTextColor:#ffffff;\r\n$toggleButtonBgColor:#ffffff;\r\n$toggleButtonBorderColor:#cccccc;\r\n$toggleButtonHoverBgColor:#e6e6e6;\r\n$toggleButtonHoverBorderColor:#adadad;\r\n\r\n/* List Items */\r\n$listPadding:6px 0;\r\n$listItemPadding:6px 20px;\r\n$listItemHoverBgColor:#f5f5f5;\r\n$listItemHoverTextColor:#292B2C;\r\n\r\n/* Messages */\r\n$infoMessageBgColor:#d9edf7;\r\n$infoMessageBorderColor:#bce8f1;\r\n$infoMessageTextColor:#31708f;\r\n$warnMessageBgColor:#fcf8e3;\r\n$warnMessageBorderColor:#faebcc;\r\n$warnMessageTextColor:#8a6d3b;\r\n$errorMessageBgColor:#f2dede;\r\n$errorMessageBorderColor:#ebccd1;\r\n$errorMessageTextColor:#a94442;\r\n$fatalMessageBgColor:#999999;\r\n$fatalMessageBorderColor:#6b6b6b;\r\n$fatalMessageTextColor:#ffffff;\r\n$successMessageBgColor:#dff0d8;\r\n$successMessageBorderColor:#d6e9c6;\r\n$successMessageTextColor:#3c763d;\r\n\r\n/* Overlays */\r\n$overlayBorderColor:#cccccc;\r\n\r\n/* Data */\r\n$datatableCellBorderColor:#dddddd;\r\n$datatableCellPadding:8px;\r\n$paginatorBgColor:#ffffff;\r\n\r\n/* Panel */\r\n$panelContentBorderColor:#DCE1E7;\r\n\r\n`\r\n}\r\n\r\n\r\n
sass/theme-v4/_variables.scss
\r\n
\r\n{\r\n`@import '../variables/common-v4';\r\n\r\n/* Icons */\r\n$iconFontSize:14px;\r\n$iconWidth:16px;\r\n\r\n/* Error */\r\n$errorColor:#a94442;\r\n$disabledColor:#eeeeee;\r\n\r\n/* Headers */\r\n$headerPadding:10px 15px;\r\n\r\n/* Contents */\r\n$contentPadding:15px;\r\n$contentBorderColor:#dddddd;\r\n$contentBgColor:#ffffff;\r\n$contentLineHeight:1.43;\r\n\r\n/* Forms */\r\n$inputBgColor:#ffffff;\r\n$inputPadding:6px 12px;\r\n$inputBorderColor:#cccccc;\r\n$inputHoverBorderColor:#cccccc;\r\n$inputTextColor:#495057;\r\n\r\n//groups\r\n$inputGroupBorderColor:#cccccc;\r\n$inputGroupBgColor:#ffffff;\r\n$inputGroupTextColor:$textColor;\r\n$inputGroupIconColor:$textSecondaryColor;\r\n$inputGroupAddonMinWidth:2*$fontSize;\r\n$checkboxWidth:20px;\r\n$checkboxHeight:20px;\r\n\r\n/* Buttons */\r\n$buttonTextColor:#ffffff;\r\n$toggleButtonBgColor:#ffffff;\r\n$toggleButtonBorderColor:#cccccc;\r\n$toggleButtonHoverBgColor:#e6e6e6;\r\n$toggleButtonHoverBorderColor:#adadad;\r\n\r\n/* List Items */\r\n$listPadding:6px 0;\r\n$listItemPadding:8px 20px;\r\n$listItemHoverBgColor:#f7f7f9;\r\n$listItemHoverTextColor:#1d1e1f;\r\n\r\n/* Messages */\r\n$infoMessageBgColor:#d9edf7;\r\n$infoMessageBorderColor:#bcdff1;\r\n$infoMessageTextColor:#31708f;\r\n$warnMessageBgColor:#fcf8e3;\r\n$warnMessageBorderColor:#faf2cc;\r\n$warnMessageTextColor:#8a6d3b;\r\n$errorMessageBgColor:#f2dede;\r\n$errorMessageBorderColor:#ebcccc;\r\n$errorMessageTextColor:#a94442;\r\n$fatalMessageBgColor:#999999;\r\n$fatalMessageBorderColor:#797979;\r\n$fatalMessageTextColor:#ffffff;\r\n$successMessageBgColor:#dff0d8;\r\n$successMessageBorderColor:#d6e9c6;\r\n$successMessageTextColor:#3c763d;\r\n\r\n/* Overlays */\r\n$overlayBorderColor:#cccccc;\r\n\r\n/* Data */\r\n$datatableCellBorderColor:#dddddd;\r\n$datatableCellPadding:8px;\r\n$paginatorBgColor:#ffffff;\r\n\r\n/* Panel */\r\n$panelContentBorderColor:#DCE1E7;\r\n\r\n\r\n`\r\n}\r\n\r\n\r\n
In the demo app layout and theme css files are defined using link tags in index.html so the demo can switch them on the fly by changing the path however if this is not a requirement, you may also import them in App.js so that webpack adds them to the bundle.
\r\n\r\n
Menu Item Badges
\r\n
Badges are numerical indicators associated with a link defined using the badge property.
\r\n
\r\nlabel: 'Components', icon: 'list', badge: '2'\r\n
\r\n\r\n
Menu Modes
\r\n
Menu has 4 modes, static, overlay, slim and horizontal. Main layout container element in App.js is used to define which mode to use by adding specific classes. List\r\n below indicates the style classes for each mode.
\r\n\r\n
\r\n - Static: \"layout-wrapper menu-layout-static\"
\r\n - Overlay: \"layout-wrapper menu-layout-overlay\"
\r\n - Slim: \"layout-wrapper menu-layout-static menu-layout-slim\"
\r\n - Horizontal: \"layout-wrapper menu-layout-static menu-layout-horizontal\"
\r\n
\r\n\r\n
For example to create a horizontal menu, the div element should be in following form;
\r\n
\r\n<div className=\"layout-wrapper menu-layout-static menu-layout-horizontal\">\r\n
\r\n\r\n
It is also possible to leave the choice to the user by keeping the preference at a component and using an expression to bind it so that user can switch between modes. Sample\r\n application has an example implementation of such use case. Refer to App.js for an example.
\r\n\r\n
Dark Menu
\r\n
Default color scheme of menu is light and alternative dark mode can be activated by adding layout-menu-dark style class to the menu container.
\r\n\r\n
\r\n<div className=\"layout-menu-container layout-menu-dark\">\r\n
\r\n\r\n
Profile Modes
\r\n
There are two possible locations for the user profile menu, first option is inline located inside the main menu and second option is the topbar menu. For inline mode,\r\n profile content should be placed above the menu and for inline mode content goes in topbar-items list. The sample demo application provides examples for\r\n both cases.
\r\n\r\n
PrimeFlex Grid System
\r\n
Avalon uses PrimeFlex Grid System throughout the samples, although any Grid library can be used we suggest using PrimeFlex as your grid system as it is well tested and supported by PrimeReact. PrimeFlex is\r\n available at npm and defined at package.json of Avalon so that it gets installed by default.
\r\n\r\n
Customizing Styles
\r\n
It is suggested to write your customizations in _layout_styles.scss and _theme_styles.scss files for seamless updates\r\n as these files are empty by default and never updated.
\r\n \r\n
Migration Guide
\r\n\t\t\t\t\t\t
2.0.0-beta.1 to 3.0.0
\r\n\t\t\t\t\t\t
\r\n\t\t\t\t\t\t\t- Update index.jx
\r\n\t\t\t\t\t\t\t- Update App.js
\r\n\t\t\t\t\t\t\t- Update AppFooter.js
\r\n\t\t\t\t\t\t\t- Update AppMenu.js
\r\n\t\t\t\t\t\t\t- Update AppInlineProfile.js
\r\n\t\t\t\t\t\t\t- Update AppTopbar.js
\r\n\t\t\t\t\t\t\t- Add AppWrapper.js
\r\n\t\t\t\t\t\t\t- Update layout css files
\r\n\t\t\t\t\t\t\t- Update theme css files
\r\n\t\t\t\t\t\t
\r\n\r\n
1.x to 2.0.0-beta.1
\r\n
Brings support to PrimeReact 2.x
\r\n
\r\n - Install PrimeFlex from npm.
\r\n - Update layout css files
\r\n - Update theme css files
\r\n
\r\n\r\n
1.6.0 to 1.6.1
\r\n
Brings support for PrimeReact 1.6.x.
\r\n\r\n
\r\n - Import primeicons.css in App.js.
\r\n - Update layout css files
\r\n - Update theme css files
\r\n
\r\n
1.5.0 to 1.6.0
\r\n
\r\n - Update AppMenu.js.
\r\n - Update layout css files.
\r\n - Update theme css files.
\r\n
\r\n
1.4.2 to 1.5.0
\r\n
\r\n - Update App.js.
\r\n - Update layout css files.
\r\n - Update theme css files.
\r\n
\r\n\r\n
1.4.1 to 1.4.2
\r\n
\r\n - Update theme css files
\r\n
\r\n\r\n
1.4.0 to 1.4.1
\r\n
\r\n - Update theme css files
\r\n
\r\n \r\n
1.0.0 to 1.4.0
\r\n
\r\n - Update PrimeReact to 1.4.0
\r\n - Update css files of theme and layout
\r\n
\r\n
![\"avalon-react\"](\"assets/layout/images/login/icon-login.svg\")
\r\n\t\t\t\t\t\t\t\t\t![\"avalon-react\"/](\"assets/layout/images/exception/icon-error.png\"){kind=icon}
\r\n\t\t\t\t![\"Logo\"](\"assets/layout/images/logo_c3leng.png\"){kind=logo}
![\"\"](\"assets/layout/images/backdrop.jpg\")
\r\n ![\"\"](\"assets/layout/images/line_qrcode.jpg\")
\r\n ![\"Logo\"](\"assets/layout/images/logo_c3leng.png\"\r\n){kind=logo}
\r\n ![\"Logo\"](\"assets/layout/images/logo-dark.png\"){kind=logo}
\r\n ![\"Brazil](\"assets/layout/images/dashboard/flag-brazil.png\")
![\"China](\"assets/layout/images/dashboard/flag-china.png\")
![\"Belgium](\"assets/layout/images/dashboard/flag-belgium.png\")
![\"France](\"assets/layout/images/dashboard/flag-france.png\")
![\"Chart](\"assets/layout/images/dashboard/graph-1.svg\")
\r\n ![\"Chart](\"assets/layout/images/dashboard/graph-2.svg\")
\r\n ![\"Chart](\"assets/layout/images/dashboard/graph-3.svg\")
\r\n ![\"User\"](\"assets/layout/images/avatar.png\"){kind=avatar}
\r\n ![\"Contact](\"assets/layout/images/avatar1.png\"){kind=avatar}
\r\n ![\"Contact](\"assets/layout/images/avatar2.png\"){kind=avatar}
\r\n ![\"Contact](\"assets/layout/images/avatar3.png\"){kind=avatar}
\r\n ![\"Contact](\"assets/layout/images/avatar4.png\"){kind=avatar}
\r\n ![\"Bridge\"](\"assets/layout/images/dashboard/bridge.png\")
\r\n ![\"Nature\"](\"assets/demo/images/nature/nature1.jpg\")
\r\n ![\"Map\"](\"assets/layout/images/dashboard/map.png\")
\r\n ![\"Profile\"](\"assets/avatar/user.png\")
\r\n );\r\n\r\n if (this.state.isLoading) {\r\n if (userInfo) {\r\n this.initial(userInfo);\r\n this.setState({ isLoadAvatar: true })\r\n }\r\n if(this.props.location.search == '?from=chat'){\r\n this.setState({ fromChat: true})\r\n }\r\n }\r\n\r\n \r\n if(userInfo){\r\n if(userInfo.person_type==1){\r\n if (userInfo.person_first_name && userInfo.person_last_name) {\r\n fullName = userInfo.person_first_name + \" \" + userInfo.person_last_name\r\n }\r\n }else{\r\n fullName = userInfo.org_name\r\n }\r\n }\r\n\r\n if (this.props.userInfo) {\r\n if (!this.props.userInfo.img_person_name) {\r\n imageProfile = (\r\n