JSN Sun Framework User's Guide

Transcription

1 JSN Sun Framework User's Guide Getting Started Layout Overview & Key concepts To start with layout configuration, Go to Extension Template JSN_template_default The first tab you see will be the Layout tab, where you can have the ultimate control of the template layout. Layout Overview Sun Layout Builder is a very flexible and powerful tool which gives you the ability to build and customize the existing template with the intuitive drag-and-drop interface. The Layout Builder consists of 3 main areas: 1. Layout Items: list of items which you can drag & drop into the layout. 2. Layout: including the main layout and 4 off-canvas regions. There are areas where your template s layout items are positioned and built. 3. Setting panel: all the settings related to layout items which are being configured. Concepts Sun Framework s layout concepts: 1. Page: Overal settings for the layout 2. Section: Section is a division of a page. A section is automatically created when you add a row to an empty area in the layout. It contains one or more row in which you can add Layout Items. 3. Row 4. Column 5. Layout items: These are smallest pieces in the layout. Each item is made up of one column. Layout Control Undo & redo Sun Layout Builder allows you to undo and redo the actions that you made. Simply hit Undo to switch back or Redo to go forth. This tool will surely save you a huge amount of time and efforts. Worry-free if you accidentally make a mistake. Save layout Sun Framework offers Ajax save button for each settings tab. Changes will be saved quickly without having to re-load the setting pages.

2 Save as custom layout This option gives you the ability to save the current layout and use it later on. To save the current layout as a custom one, just click on Save on custom layout. After that, type the name of the layout. Load custom layout This button enables you to load custom layout that you saved. Building a layout Drag & drop

3 You can start building your own layout by drag & drop items on the left panel into the layout area. After that, you can adjust their settings via the right panel. If you drag a new item into a blank area of the layout, it will automatically create a row, a column and section wrapped around this item. If you drag a new item below an existing row, a new row which contains this new item will be created. These two rows will be in the same section. If you drag a new item below an existing item/row in a column, these two items will be wrapped in the same column. You can drag an existing item in the layout to any position simply by clicking on the drag icon in the item and bringing it to anywhere you want. Adjusting column width To change a column width, simply move your mouse cursor on the dividing line between two columns and drag it left or right, depending on how you want it to go. Sun Framework utilizes Bootstrap 3, which means there will be 12 columns in the layout. Common settings Most of the items in Sun s layout share the following settings Hide Clone Delete Custom classes: for custom styling Responsive display: hide or display item in different viewports (applied for columns/items)

4 Page settings This panel is the first thing you see when opening the Layout tab. It contains general settings for the page layout. Enable responsive Show desktop switcher Boxed layout Margin Show Go to Top button Turn on or off responsive layout mode. This feature is on by default Display an icon that allows you to switch from mobile view to desktop view. Change from full-width layout to boxed layout. Upon selecting this option, you can set the width for your layout. Set margin values for the page Display go-to-top button near the bottom of the website. Upon selecting this option, you can select proper icons for this button. Section settings A section is automatically created when you drag a Layout Item into a blank area in the layout Section settings will appear when you select any section in the layout. See the available settings for a section in the screenshot below: Enable full width Enable sticky Margin Padding Set full-width layout for a section Set sticky mode for a section. This feature is often used for header section Set margin values for a section Set padding values for a section Row settings Row settings will appear when you select any row in the layout. See the available settings for a row in the screenshot below:

5 Row settings will appear when you select any row in the layout. See the available settings for a row in the screenshot below: Margin Padding Custom classes Set margin values for a section Set padding values for a section Specific CSS classes for custom styling Column settings Column settings will appear when you select any column in the layout. See the available settings for a column in the screenshot below. Margin Padding CSS classes Display in layouts Set margin values for a section Set padding values for a section Specific CSS classes for custom styling Set visibility of columns in each viewport: mobile, tablet, laptop, desktop Layout item settings Layout items The list of layout items can be found on the left sidebar. These items include Logos, Menu, Module position, Module, Social Icons, Custom HTML, Flexible Space. Item-specific settings Logo

6 The Logo item enables you to set the image you want to use as your website logo. With this item, you can add your logo to the site in any position of Layout Builder. With this item, you can set up separate logos for desktop and mobile view. Custom logo link can also configure. If left blank as default, the logo will be linked to the homepage. Logo Mobile logo Logo Alt text Logo link CSS classes Browse the image that appears as the logo Browse the image that appears as the mobile logo Alt text for logo image By default, the home page is used. Users can set a custom URL the logo links to when needed. Specific CSS classes for custom styling Menu Menu item allows you to place any Joomla menu in a position in the layout. Menu Base item Start Level End Level Show icon The name of the menu you want to assign to the menu item Sets the base item path for the menu item Sets the starting level for the menu. Sets the deepest level at which the menu particle renders the menu. Display icon for menu item

7 Show description Sub-menu effects Show submenu Mobile Target Display description for menu item Select effects applied for submenu Display sub-menu Collapse menu in mobile view. This is useful when you have multiple menus in the layout, but you only want one menu to be used as mobile menu (with hamburger icon). Module Position To create a position in the layout, simply drag the item name Module position into the layout, type the position name and click OK. Position name Custom CSS Name of the module position. Specific CSS classes for custom styling Single Module

8 This item gives you the ability to add a module instance anywhere in the layout without going to Joomla s module manager section. This item comes with a module picker, which enables you to quickly select a relevant Joomla module using module name. Name Module Configure module Backend name of the module, for administration purposes only. Front-end users will not see this name. Use the module picker to select a module. To change module-related settings at Joomla's Module Manager. Mainbody (component) This item shows the contents of Joomla mainbody. You can turn it on or off on frontpage. Note that this item does not have any settings. Social Icons

9 The Social Icons item enables you to select and add social icons, including their links, sizes and colors, into the layout. Name Add social icons Icon color Icon size Link target Backend name of the module, for administration purposes only. Select the icons for each social channel Select color for icons Set the size for icons Set how selected links will open: in the current browser window, or a new one. To add an icon, first click on Add social icon, then click on the hamburger button to open a pop-up that contains additional fields to configure each individual social item. Social network Social profile link Social icon Select social network, such facebook, twitter, etc. Set the link for the social network Select the icon related to the social network selected above Custom HTML The Custom HTML item allows you to add custom HTML content to your page via Layout Builder and takes the place of the Custom HTML module in Joomla. HTML Custom HTML content

10 Flexible Space Flexible Space allows you to add an empty space between items in the layout. This item doesn't have any special function but merely a styling tool. Off-canvas section This section give you the ability to place menus, modules and positions in a special off-canvas sidebar, used for both desktop and mobile view. The Sun framework offers 4 off-canvas sections, which are located on the top, right, bottom and left side of the layout. To set up a off-canvas section, you only need to click on one of the toggle buttons, which are available on each side of the layout builder, depending on where you want the off-canvas section to display on the front end. Width Height Padding Toggle position Custom classes The width of the off-canvas section (Applied for left and right off-canvas only) The height of the off-canvas section (Applied for top and bottom off-canvas only) Set the padding value, including top, right, bottom and left padding Set the position of the toggle button Add custom CSS classes for the off-canvas section. Responsive layout The responsive mode is enabled by default. If you don t want to use Responsive Layout, go back to Page and deselect Enable Responsive. You can adjust the width of each item in tablet and mobile, as well as their visibility in each viewport, by going to each viewport and change its settings. The responsive viewport of Sun Framework layout is similar to that of Bootstrap 3. For further information, please see it. Working with Layout Items Drag & drop

11 You can start building your own layout by drag & drop items on the left panel into the layout area. After that, you can adjust their settings via the right panel. If you drag a new item into a blank area of the layout, it will automatically create a row, a column and section wrapped around this item. If you drag a new item below an existing row, a new row which contains this new item will be created. These two rows will be in the same section. If you drag a new item below an existing item/row in a column, these two items will be wrapped in the same column. You can drag an existing item in the layout to any position simply by clicking on the drag icon in the item and bringing it to anywhere you want. Adjusting column width To change a column width, simply move your mouse cursor on the dividing line between two columns and drag it left or right, depending on how you want it to go. Sun Framework utilizes Bootstrap 3, which means there will be 12 columns in the layout. Layout Common settings Most of the items in Sun s layout share the following settings Hide Clone Delete Custom classes: for custom styling Responsive display: hide or display item in different viewports (applied for columns/items)

12 Page settings This panel is the first thing you see when opening the Layout tab. It contains general settings for the page layout. Enable responsive Show desktop switcher Boxed layout Margin Show Go to Top button Turn on or off responsive layout mode. This feature is on by default Display an icon that allows you to switch from mobile view to desktop view. Change from full-width layout to boxed layout. Upon selecting this option, you can set the width for your layout. Set margin values for the page Display go-to-top button near the bottom of the website. Upon selecting this option, you can select proper icons for this button. Section settings A section is automatically created when you drag a Layout Item into a blank area in the layout Section settings will appear when you select any section in the layout. See the available settings for a section in the screenshot below:

13 Enable full width Enable sticky Margin Padding Set full-width layout for a section Set sticky mode for a section. This feature is often used for header section Set margin values for a section Set padding values for a section Row settings Row settings will appear when you select any row in the layout. See the available settings for a row in the screenshot below: Margin Padding Custom classes Set margin values for a section Set padding values for a section Specific CSS classes for custom styling Column settings Column settings will appear when you select any column in the layout. See the available settings for a column in the screenshot below. Margin Padding CSS classes Display in layouts Set margin values for a section Set padding values for a section Specific CSS classes for custom styling Set visibility of columns in each viewport: mobile, tablet, laptop, desktop Layout Items Layout items The list of layout items can be found on the left sidebar. These items include Logos, Menu, Module position, Module, Social Icons, Custom HTML, Flexible Space.

14 Item-specific settings Logo The Logo item enables you to set the image you want to use as your website logo. With this item, you can add your logo to the site in any position of Layout Builder. With this item, you can set up separate logos for desktop and mobile view. Custom logo link can also configure. If left blank as default, the logo will be linked to the homepage. Logo Mobile logo Logo Alt text Logo link CSS classes Browse the image that appears as the logo Browse the image that appears as the mobile logo Alt text for logo image By default, the home page is used. Users can set a custom URL the logo links to when needed. Specific CSS classes for custom styling Menu

15 Menu item allows you to place any Joomla menu in a position in the layout. Menu Base item Start Level End Level Show icon Show description Sub-menu effects Show submenu Mobile Target The name of the menu you want to assign to the menu item Sets the base item path for the menu item Sets the starting level for the menu. Sets the deepest level at which the menu particle renders the menu. Display icon for menu item Display description for menu item Select effects applied for submenu Display sub-menu Collapse menu in mobile view. This is useful when you have multiple menus in the layout, but you only want one menu to be used as mobile menu (with hamburger icon). Module Position To create a position in the layout, simply drag the item name Module position into the layout, type the position name and click OK. Position name Custom CSS Name of the module position. Specific CSS classes for custom styling

16 Single Module This item gives you the ability to add a module instance anywhere in the layout without going to Joomla s module manager section. This item comes with a module picker, which enables you to quickly select a relevant Joomla module using module name. Name Module Configure module Backend name of the module, for administration purposes only. Front-end users will not see this name. Use the module picker to select a module. To change module-related settings at Joomla's Module Manager. Mainbody (component) This item shows the contents of Joomla mainbody. You can turn it on or off on frontpage. Note that this item does not have any settings. Social Icons

17 The Social Icons item enables you to select and add social icons, including their links, sizes and colors, into the layout. Name Add social icons Icon color Icon size Link target Backend name of the module, for administration purposes only. Select the icons for each social channel Select color for icons Set the size for icons Set how selected links will open: in the current browser window, or a new one. To add an icon, first click on Add social icon, then click on the hamburger button to open a pop-up that contains additional fields to configure each individual social item. Social network Social profile link Social icon Select social network, such facebook, twitter, etc. Set the link for the social network Select the icon related to the social network selected above Custom HTML

18 The Custom HTML item allows you to add custom HTML content to your page via Layout Builder and takes the place of the Custom HTML module in Joomla. HTML Custom HTML content Flexible Space Flexible Space allows you to add an empty space between items in the layout. This item doesn't have any special function but merely a styling tool. Off-canvas section This section give you the ability to place menus, modules and positions in a special off-canvas sidebar, used for both desktop and mobile view. The Sun framework offers 4 off-canvas sections, which are located on the top, right, bottom and left side of the layout. To set up an off-canvas section, you only need to click on one of the toggle buttons, which are available on each side of the layout builder, depending on where you want the off-canvas section to display on the front end. Width Height Padding Toggle position Custom classes The width of the off-canvas section (Applied for left and right off-canvas only) The height of the off-canvas section (Applied for top and bottom off-canvas only) Set the padding value, including top, right, bottom and left padding Set the position of the toggle button Add custom CSS classes for the off-canvas section. Responsive layout

19 The responsive mode is enabled by default. If you don t want to use Responsive Layout, go back to Page and deselect Enable Responsive. You can adjust the width of each item in tablet and mobile, as well as their visibility in each viewport, by going to each viewport and change its settings. The responsive viewport of Sun Framework layout is similar to that of Bootstrap 3. For further information, please see it here: Style The Sun framework enables you to create custom style for almost everything on the template. General Section Module Menu Overall styles for the layout Style options for all the sections Style options for all the modules Style options for all the menus This section covers the basics of style customization in {jsn_ld_param key=template-full-name /} and other templates powered by Sun Framework. Further details about the use of styling tools in Sun Framework can be found in Sun Framework Documentation (/joomla-hub/sunframework-documentation.html) General Style Page style This area gives you the ability to edit overall styles for both page outer and page inner. If boxed layout is disabled, only settings for page outer style will be displayed: Boxed layout is disabled

20 Boxed layout is disabled If boxed layout is enabled, settings for both page outer and page inner style will be displayed: Boxed layout is enabled Page outer Background color Background image Background image settings Page inner Background color Border Boxed shadow These settings are visible ONLY when boxed layout is enabled Background color of the page outer. Background image of the page outer. when background image is used. Background color of the page inner. Page border values. Visible only when boxed layout is enabled. Used when boxed layout is enable Color style To set up the style color for main and sub in the template, click on Main color and sub color in the preview panel on the left side and change their settings on the right panel. Style color for main and sub in the template Heading style To set up the style for all the headings in the template, click on any heading in the preview panel on the left side and change their settings on the right panel.

21 Style all heading in the template Content style To set up the style for content text, click on the paragraph text area under the heading in the preview panel on the left side and change their settings on the right panel. Style for content text in the template Button style To set up the style for buttons, including default and primary button, click on each of these buttons on the preview panel and change its settings on the right panel. Link style Style for buttons in the template To set up the style for links, click on the link in the preview panel on the left side and change its settings on the right panel.

22 Style for link in the template Section Style Go to the Stye tab, you will see the same section names and many styling options for each of them. For example, the style for section "Top" in layout tab will also be under section "Top" in style tab. This makes it easy for you to locate where the customization can take place. Section container You can change the style of each section s container simply by clicking on the area around the border of the section that you want to have custom style, and change its settings on the right panel. Style section's container Section heading By default, section headings style will be inherited from General style. If you want to have different styles for section headings, click on Use custom settings to activate custom style settings. Section content Style section's heading

23 Section content By default, section content style will be inherited from General style. If you want to have different style for section content, click on Use custom settings to activate custom content style settings. Style section's content Section button By default, section button style will be inherited from General style. If you want to have different style for section button, click on Use custom settings to activate custom button style settings. Style section's button Section link By default, section link style will be inherited from General style. If you want to have different style for section link, click on Use custom settings to activate custom link style settings. Style section's link Module Style First, Go to tab Style --> Module From here you will see some module styles provided by the template. The Sun Framework comes with 4 highly flexible module styles, and you can customize each of them in the same way with Section.

24 The Sun Framework comes with 4 highly flexible module styles, and you can customize each of them in the same way with Section. Module container Similar to section container style, you can change the style of each module s container simply by clicking on the module that you want to have custom style, and change its settings on the right panel. Module Title Style module's container To change the style of a module s title, click on the title of the module style that you want to customize in order to see its available settings. Style module's title Module content To change the style of a module s content, click on the content area of the module style that you want to customize in order to see its available settings. Style module's content

25 Module button By default, the button style of the module is inherited from the General settings. To enable custom style for module settings, select Use custom setting to open custom style options and make changes as you want. Module link Style module's button To change the style of a module s hyperlink, click on link in the module style that you want to customize in order to see its settings. Style module's link To apply a style to a module: Open a module in Joomla Module Manager Go to Advanced tab: 1. Select a style from the list in the dropdown 2. Add FontAwesome code in Header Class to have icons for your module heading Apply a style to a module More FontAwesome icons can be found here: Menu Style To change a menu style, go to tab menu and change their style settings in the right panel. To change a parental menu style, click on any parental menu item to open its settings and customize it.

26 Style for menu root To change a sub-menu item style, click on the submenu in the preview panel to open the settings. Style for menu dropdown Sun Megamenu Sun Framework, as well as templates built with this framework, allows you to create a mega menu for site navigation and usability enhancement. They provide a visual way to create a mega menu with clicks and drag-n-drop function, without touching a single line of code. Everything is done in a similar way the Layout is built. To set up mega menu, click Mega Menu on top bar of the template framework. Set up Mega menu Megamenu in templates powered by Sun Framework can be built with the following steps: Select the menu & language of the menu that you want to config Drag menu item into the main menu panel. for each of these items will be available on the right panel. Config menu container, row and column in the same way you do with the Layout. Mega Menu Layout & Style Menu container

27 Menu row Menu column Mega Menu Item General function Similar to items in the layout, each of the Mega Menu item, row and column shares the following functions, which are available in the right panel. Hide: temporarily hide item/row/column Clone: clone item/row/column Remove: remove item/row/column Megamenu items Apart from submenu item, Megamenu includes items similar to those in Layout builder, namely Module, Position, Custom HTML, Image. Details about their settings can be found in Layout chapter. System

28 Assets Compression With Sun Framework, we put great effort into optimizing our templates performance with multiple techniques like image sprites application, clean html code output and now one new step CSS/JS Compression. What it does is combining all continuous CSS/JS files into compressed files and delivering it in GZIP compressed state to browser. The order of CSS/JS files is the same before and after the compression. This feature significantly reduces http request number to server as well as overall loading size, which results in significant performance boost. You can configure the compression settings in the tab Advanced section Assets Compression : Compress CSS/JS: Allows you to select to compress both CSS and JS, Only CSS, Only JS or nothing. Max File Size: Defines the maximum size a compressed file should be. Exclude from compression: Set a list of files you don t want to be compre Cache Directory: Specify the directory for storing compressed CSS/JS file Custom code You can define where to insert the code by template parameter Analytics Code Position. There are two options to choose from: Before tag Before tag

29 Custom files For all customization purposes, Sun framework allows you to load multiple CSS / JS files you customized without altering the template core files. Just put custom CSS/JS files to template's CSS/JS folder and define them in template parameter Custom CSS File(s) and Custom JS File(s); each file name at a line. Please note: If you enable CSS/JS Compression feature, all custom CSS files will be compressed as well. Cookie Consent To enable Cookies consent, go to Extras Cookie Law Select Enable Cookie Consent to config its layout styles and contents. Enable Cookie ConsentChoose whether to use Cookie Law. Style There are 2 styles of Cookie Law to choose from: Light and Dark Banner Placement Select position of initial consent slide-down notification Message Cookie law content: You can use either a simple text message for cookie law, or use an article to display the message. Accept Button Text The label of the accept button Read More Button TextThe text shown on the link to the cookie policy (requires Your Cookie Policy Link to be set) Cookie Policy link The url of the Cookie Policy. If left blank, the link will be hidden. Once the cookie law is enabled, you will have two options: Enter your cookie law notification message Use an article as cookie law: this option is perfect when you want to create a multilingual cookie law notification Using a simple cookie law message In the box Message, select Text Enter your cookie law notification message in the text box as well as config other params

30 Using an article to display a cookie law message This option is important when you want to have a multi-lingual cookie law message To use this option, in the box Message -> Select Articles. Then browse the article that you want to use as your Cookie Law message Menu Assignment This is where you assign the template style to specific menu items. All of your menu items will be listed here. After assigning the menu item for your template, click Save Assignment to save the settings. Import/Export

31 The Sun Framework enables you to export and import your template settings. You can export all the setting that you configured to save as a backup file or reuse it somewhere. To import/export template settings, go to the top menu Maintenance select Import or Export Please note: When you import the backup file, your current template settings will be overwritten. Configuration Layout Overview & Key concepts To start with layout configuration, Go to Extension Template JSN_template_default The first tab you see will be the Layout tab, where you can have the ultimate control of the template layout. Layout Overview Sun Layout Builder is a very flexible and powerful tool which gives you the ability to build and customize the existing template with the intuitive drag-and-drop interface. The Layout Builder consists of 3 main areas: 1. Layout Items: list of items which you can drag & drop into the layout. 2. Layout: including the main layout and 4 off-canvas regions. There are areas where your template s layout items are positioned and built. 3. Setting panel: all the settings related to layout items which are being configured. Concepts Sun Framework s layout concepts: 1. Page: Overal settings for the layout 2. Section: Section is a division of a page. A section is automatically created when you add a row to an empty area in the layout. It contains one or more row in which you can add Layout Items. 3. Row 4. Column 5. Layout items: These are smallest pieces in the layout. Each item is made up of one column. Layout Control Undo & redo Sun Layout Builder allows you to undo and redo the actions that you made. Simply hit Undo to switch back or Redo to go forth. This tool will surely save you a huge amount of time and efforts. Worry-free if you accidentally make a mistake. Save layout Sun Framework offers Ajax save button for each settings tab. Changes will be saved quickly without having to re-load the setting pages. Save as custom layout

32 Save as custom layout This option gives you the ability to save the current layout and use it later on. To save the current layout as a custom one, just click on Save on custom layout. After that, type the name of the layout. Load custom layout This button enables you to load custom layout that you saved. Building a layout Drag & drop

33 You can start building your own layout by drag & drop items on the left panel into the layout area. After that, you can adjust their settings via the right panel. If you drag a new item into a blank area of the layout, it will automatically create a row, a column and section wrapped around this item. If you drag a new item below an existing row, a new row which contains this new item will be created. These two rows will be in the same section. If you drag a new item below an existing item/row in a column, these two items will be wrapped in the same column. You can drag an existing item in the layout to any position simply by clicking on the drag icon in the item and bringing it to anywhere you want. Adjusting column width To change a column width, simply move your mouse cursor on the dividing line between two columns and drag it left or right, depending on how you want it to go. Sun Framework utilizes Bootstrap 3, which means there will be 12 columns in the layout. Common settings Most of the items in Sun s layout share the following settings Hide Clone Delete Custom classes: for custom styling Responsive display: hide or display item in different viewports (applied for columns/items)

34 Page settings This panel is the first thing you see when opening the Layout tab. It contains general settings for the page layout. Enable responsive Show desktop switcher Boxed layout Margin Show Go to Top button Turn on or off responsive layout mode. This feature is on by default Display an icon that allows you to switch from mobile view to desktop view. Change from full-width layout to boxed layout. Upon selecting this option, you can set the width for your layout. Set margin values for the page Display go-to-top button near the bottom of the website. Upon selecting this option, you can select proper icons for this button. Section settings A section is automatically created when you drag a Layout Item into a blank area in the layout Section settings will appear when you select any section in the layout. See the available settings for a section in the screenshot below: Enable full width Enable sticky Margin Padding Set full-width layout for a section Set sticky mode for a section. This feature is often used for header section Set margin values for a section Set padding values for a section Row settings Row settings will appear when you select any row in the layout. See the available settings for a row in the screenshot below:

35 Margin Padding Custom classes Set margin values for a section Set padding values for a section Specific CSS classes for custom styling Column settings Column settings will appear when you select any column in the layout. See the available settings for a column in the screenshot below. Margin Padding CSS classes Display in layouts Set margin values for a section Set padding values for a section Specific CSS classes for custom styling Set visibility of columns in each viewport: mobile, tablet, laptop, desktop Layout item settings Layout items The list of layout items can be found on the left sidebar. These items include Logos, Menu, Module position, Module, Social Icons, Custom HTML, Flexible Space. Item-specific settings Logo

36 The Logo item enables you to set the image you want to use as your website logo. With this item, you can add your logo to the site in any position of Layout Builder. With this item, you can set up separate logos for desktop and mobile view. Custom logo link can also configure. If left blank as default, the logo will be linked to the homepage. Logo Mobile logo Logo Alt text Logo link CSS classes Browse the image that appears as the logo Browse the image that appears as the mobile logo Alt text for logo image By default, the home page is used. Users can set a custom URL the logo links to when needed. Specific CSS classes for custom styling Menu Menu item allows you to place any Joomla menu in a position in the layout. Menu Base item Start Level End Level Show icon Show The name of the menu you want to assign to the menu item Sets the base item path for the menu item Sets the starting level for the menu. Sets the deepest level at which the menu particle renders the menu. Display icon for menu item

37 Show description Sub-menu effects Show submenu Mobile Target Display description for menu item Select effects applied for submenu Display sub-menu Collapse menu in mobile view. This is useful when you have multiple menus in the layout, but you only want one menu to be used as mobile menu (with hamburger icon). Module Position To create a position in the layout, simply drag the item name Module position into the layout, type the position name and click OK. Position name Custom CSS Name of the module position. Specific CSS classes for custom styling Single Module

38 This item gives you the ability to add a module instance anywhere in the layout without going to Joomla s module manager section. This item comes with a module picker, which enables you to quickly select a relevant Joomla module using module name. Name Module Configure module Backend name of the module, for administration purposes only. Front-end users will not see this name. Use the module picker to select a module. To change module-related settings at Joomla's Module Manager. Mainbody (component) This item shows the contents of Joomla mainbody. You can turn it on or off on frontpage. Note that this item does not have any settings. Social Icons

39 The Social Icons item enables you to select and add social icons, including their links, sizes and colors, into the layout. Name Add social icons Icon color Icon size Link target Backend name of the module, for administration purposes only. Select the icons for each social channel Select color for icons Set the size for icons Set how selected links will open: in the current browser window, or a new one. To add an icon, first click on Add social icon, then click on the hamburger button to open a pop-up that contains additional fields to configure each individual social item. Social network Social profile link Social icon Select social network, such facebook, twitter, etc. Set the link for the social network Select the icon related to the social network selected above Custom HTML The Custom HTML item allows you to add custom HTML content to your page via Layout Builder and takes the place of the Custom HTML module in Joomla. HTML Custom HTML content

40 Flexible Space Flexible Space allows you to add an empty space between items in the layout. This item doesn't have any special function but merely a styling tool. Off-canvas section This section give you the ability to place menus, modules and positions in a special off-canvas sidebar, used for both desktop and mobile view. The Sun framework offers 4 off-canvas sections, which are located on the top, right, bottom and left side of the layout. To set up a off-canvas section, you only need to click on one of the toggle buttons, which are available on each side of the layout builder, depending on where you want the off-canvas section to display on the front end. Width Height Padding Toggle position Custom classes The width of the off-canvas section (Applied for left and right off-canvas only) The height of the off-canvas section (Applied for top and bottom off-canvas only) Set the padding value, including top, right, bottom and left padding Set the position of the toggle button Add custom CSS classes for the off-canvas section. Responsive layout The responsive mode is enabled by default. If you don t want to use Responsive Layout, go back to Page and deselect Enable Responsive. You can adjust the width of each item in tablet and mobile, as well as their visibility in each viewport, by going to each viewport and change its settings. The responsive viewport of Sun Framework layout is similar to that of Bootstrap 3. For further information, please see it. Working with Layout Items Drag & drop

41 You can start building your own layout by drag & drop items on the left panel into the layout area. After that, you can adjust their settings via the right panel. If you drag a new item into a blank area of the layout, it will automatically create a row, a column and section wrapped around this item. If you drag a new item below an existing row, a new row which contains this new item will be created. These two rows will be in the same section. If you drag a new item below an existing item/row in a column, these two items will be wrapped in the same column. You can drag an existing item in the layout to any position simply by clicking on the drag icon in the item and bringing it to anywhere you want. Adjusting column width To change a column width, simply move your mouse cursor on the dividing line between two columns and drag it left or right, depending on how you want it to go. Sun Framework utilizes Bootstrap 3, which means there will be 12 columns in the layout. Layout Common settings Most of the items in Sun s layout share the following settings Hide Clone Delete Custom classes: for custom styling Responsive display: hide or display item in different viewports (applied for columns/items)

42 Page settings This panel is the first thing you see when opening the Layout tab. It contains general settings for the page layout. Enable responsive Show desktop switcher Boxed layout Margin Show Go to Top button Turn on or off responsive layout mode. This feature is on by default Display an icon that allows you to switch from mobile view to desktop view. Change from full-width layout to boxed layout. Upon selecting this option, you can set the width for your layout. Set margin values for the page Display go-to-top button near the bottom of the website. Upon selecting this option, you can select proper icons for this button. Section settings A section is automatically created when you drag a Layout Item into a blank area in the layout Section settings will appear when you select any section in the layout. See the available settings for a section in the screenshot below: Enable full width Set full-width layout for a section

43 Enable full width Enable sticky Margin Padding Set full-width layout for a section Set sticky mode for a section. This feature is often used for header section Set margin values for a section Set padding values for a section Row settings Row settings will appear when you select any row in the layout. See the available settings for a row in the screenshot below: Margin Padding Custom classes Set margin values for a section Set padding values for a section Specific CSS classes for custom styling Column settings Column settings will appear when you select any column in the layout. See the available settings for a column in the screenshot below. Margin Padding CSS classes Display in layouts Set margin values for a section Set padding values for a section Specific CSS classes for custom styling Set visibility of columns in each viewport: mobile, tablet, laptop, desktop Layout Items Layout items The list of layout items can be found on the left sidebar. These items include Logos, Menu, Module position, Module, Social Icons, Custom HTML, Flexible Space.

44 Item-specific settings Logo The Logo item enables you to set the image you want to use as your website logo. With this item, you can add your logo to the site in any position of Layout Builder. With this item, you can set up separate logos for desktop and mobile view. Custom logo link can also configure. If left blank as default, the logo will be linked to the homepage. Logo Mobile logo Logo Alt text Logo link CSS classes Browse the image that appears as the logo Browse the image that appears as the mobile logo Alt text for logo image By default, the home page is used. Users can set a custom URL the logo links to when needed. Specific CSS classes for custom styling Menu

45 Menu item allows you to place any Joomla menu in a position in the layout. Menu Base item Start Level End Level Show icon Show description Sub-menu effects Show submenu Mobile Target The name of the menu you want to assign to the menu item Sets the base item path for the menu item Sets the starting level for the menu. Sets the deepest level at which the menu particle renders the menu. Display icon for menu item Display description for menu item Select effects applied for submenu Display sub-menu Collapse menu in mobile view. This is useful when you have multiple menus in the layout, but you only want one menu to be used as mobile menu (with hamburger icon). Module Position To create a position in the layout, simply drag the item name Module position into the layout, type the position name and click OK. Position name Custom CSS Name of the module position. Specific CSS classes for custom styling

46 Single Module This item gives you the ability to add a module instance anywhere in the layout without going to Joomla s module manager section. This item comes with a module picker, which enables you to quickly select a relevant Joomla module using module name. Name Module Configure module Backend name of the module, for administration purposes only. Front-end users will not see this name. Use the module picker to select a module. To change module-related settings at Joomla's Module Manager. Mainbody (component) This item shows the contents of Joomla mainbody. You can turn it on or off on frontpage. Note that this item does not have any settings. Social Icons

47 The Social Icons item enables you to select and add social icons, including their links, sizes and colors, into the layout. Name Add social icons Icon color Icon size Link target Backend name of the module, for administration purposes only. Select the icons for each social channel Select color for icons Set the size for icons Set how selected links will open: in the current browser window, or a new one. To add an icon, first click on Add social icon, then click on the hamburger button to open a pop-up that contains additional fields to configure each individual social item. Social network Social profile link Social icon Select social network, such facebook, twitter, etc. Set the link for the social network Select the icon related to the social network selected above Custom HTML

48 The Custom HTML item allows you to add custom HTML content to your page via Layout Builder and takes the place of the Custom HTML module in Joomla. HTML Custom HTML content Flexible Space Flexible Space allows you to add an empty space between items in the layout. This item doesn't have any special function but merely a styling tool. Off-canvas section This section give you the ability to place menus, modules and positions in a special off-canvas sidebar, used for both desktop and mobile view. The Sun framework offers 4 off-canvas sections, which are located on the top, right, bottom and left side of the layout. To set up an off-canvas section, you only need to click on one of the toggle buttons, which are available on each side of the layout builder, depending on where you want the off-canvas section to display on the front end. Width Height Padding Toggle position Custom classes The width of the off-canvas section (Applied for left and right off-canvas only) The height of the off-canvas section (Applied for top and bottom off-canvas only) Set the padding value, including top, right, bottom and left padding Set the position of the toggle button Add custom CSS classes for the off-canvas section. Responsive layout

49 The responsive mode is enabled by default. If you don t want to use Responsive Layout, go back to Page and deselect Enable Responsive. You can adjust the width of each item in tablet and mobile, as well as their visibility in each viewport, by going to each viewport and change its settings. The responsive viewport of Sun Framework layout is similar to that of Bootstrap 3. For further information, please see it here: Style The Sun framework enables you to create custom style for almost everything on the template. General Section Module Menu Overall styles for the layout Style options for all the sections Style options for all the modules Style options for all the menus This section covers the basics of style customization in {jsn_ld_param key=template-full-name /} and other templates powered by Sun Framework. Further details about the use of styling tools in Sun Framework can be found in Sun Framework Documentation (/joomla-hub/sunframework-documentation.html) General Style Page style This area gives you the ability to edit overall styles for both page outer and page inner. If boxed layout is disabled, only settings for page outer style will be displayed: Boxed layout is disabled

50 If boxed layout is enabled, settings for both page outer and page inner style will be displayed: Boxed layout is enabled Page outer Background color Background image Background image settings Page inner Background color Border Boxed shadow These settings are visible ONLY when boxed layout is enabled Background color of the page outer. Background image of the page outer. when background image is used. Background color of the page inner. Page border values. Visible only when boxed layout is enabled. Used when boxed layout is enable Color style To set up the style color for main and sub in the template, click on Main color and sub color in the preview panel on the left side and change their settings on the right panel. Style color for main and sub in the template Heading style To set up the style for all the headings in the template, click on any heading in the preview panel on the left side and change their settings on the right panel.

51 Style all heading in the template Content style To set up the style for content text, click on the paragraph text area under the heading in the preview panel on the left side and change their settings on the right panel. Style for content text in the template Button style To set up the style for buttons, including default and primary button, click on each of these buttons on the preview panel and change its settings on the right panel. Link style Style for buttons in the template To set up the style for links, click on the link in the preview panel on the left side and change its settings on the right panel.

52 Style for link in the template Section Style Go to the Stye tab, you will see the same section names and many styling options for each of them. For example, the style for section "Top" in layout tab will also be under section "Top" in style tab. This makes it easy for you to locate where the customization can take place. Section container You can change the style of each section s container simply by clicking on the area around the border of the section that you want to have custom style, and change its settings on the right panel. Style section's container Section heading By default, section headings style will be inherited from General style. If you want to have different styles for section headings, click on Use custom settings to activate custom style settings. Section content Style section's heading

53 By default, section content style will be inherited from General style. If you want to have different style for section content, click on Use custom settings to activate custom content style settings. Style section's content Section button By default, section button style will be inherited from General style. If you want to have different style for section button, click on Use custom settings to activate custom button style settings. Style section's button Section link By default, section link style will be inherited from General style. If you want to have different style for section link, click on Use custom settings to activate custom link style settings. Style section's link Module Style First, Go to tab Style --> Module From here you will see some module styles provided by the template. The Sun Framework comes with 4 highly flexible module styles, and you can customize each of them in the same way with Section.

54 Module container Similar to section container style, you can change the style of each module s container simply by clicking on the module that you want to have custom style, and change its settings on the right panel. Module Title Style module's container To change the style of a module s title, click on the title of the module style that you want to customize in order to see its available settings. Style module's title Module content To change the style of a module s content, click on the content area of the module style that you want to customize in order to see its available settings. Module button Style module's content

55 Module button By default, the button style of the module is inherited from the General settings. To enable custom style for module settings, select Use custom setting to open custom style options and make changes as you want. Module link Style module's button To change the style of a module s hyperlink, click on link in the module style that you want to customize in order to see its settings. Style module's link To apply a style to a module: Open a module in Joomla Module Manager Go to Advanced tab: 1. Select a style from the list in the dropdown 2. Add FontAwesome code in Header Class to have icons for your module heading

56 Apply a style to a module More FontAwesome icons can be found here: Menu Style To change a menu style, go to tab menu and change their style settings in the right panel. To change a parental menu style, click on any parental menu item to open its settings and customize it. Style for menu root To change a sub-menu item style, click on the submenu in the preview panel to open the settings. Style for menu dropdown Sun Megamenu Sun Framework, as well as templates built with this framework, allows you to create a mega menu for site navigation and usability enhancement. They provide a visual way to create a mega menu with clicks and drag-n-drop function, without touching a single line of code. Everything is done in a similar way the Layout is built. To set up mega menu, click Mega Menu on top bar of the template framework.

57 Set up Mega menu Megamenu in templates powered by Sun Framework can be built with the following steps: Select the menu & language of the menu that you want to config Drag menu item into the main menu panel. for each of these items will be available on the right panel. Config menu container, row and column in the same way you do with the Layout. Mega Menu Layout & Style Menu container Menu row Menu column Mega Menu Item General function

58 Similar to items in the layout, each of the Mega Menu item, row and column shares the following functions, which are available in the right panel. Hide: temporarily hide item/row/column Clone: clone item/row/column Remove: remove item/row/column Megamenu items Apart from submenu item, Megamenu includes items similar to those in Layout builder, namely Module, Position, Custom HTML, Image. Details about their settings can be found in Layout chapter. System Assets Compression With Sun Framework, we put great effort into optimizing our templates performance with multiple techniques like image sprites application, clean html code output and now one new step CSS/JS Compression. What it does is combining all continuous CSS/JS files into compressed files and delivering it in GZIP compressed state to browser. The order of CSS/JS files is the same before and after the compression. This feature significantly reduces http request number to server as well as overall loading size, which results in significant performance boost. You can configure the compression settings in the tab Advanced section Assets Compression : Compress CSS/JS: Allows you to select to compress both CSS and JS, Only CSS, Only JS or nothing. Max File Size: Defines the maximum size a compressed file should be. Exclude from compression: Set a list of files you don t want to be compre Cache Directory: Specify the directory for storing compressed CSS/JS file

59 Custom code You can define where to insert the code by template parameter Analytics Code Position. There are two options to choose from: Before tag Before tag Custom files For all customization purposes, Sun framework allows you to load multiple CSS / JS files you customized without altering the template core files. Just put custom CSS/JS files to template's CSS/JS folder and define them in template parameter Custom CSS File(s) and Custom JS File(s); each file name at a line. Please note: If you enable CSS/JS Compression feature, all custom CSS files will be compressed as well. Cookie Consent To enable Cookies consent, go to Extras Cookie Law Select Enable Cookie Consent to config its layout styles and contents.

60 Enable Cookie ConsentChoose whether to use Cookie Law. Style There are 2 styles of Cookie Law to choose from: Light and Dark Banner Placement Select position of initial consent slide-down notification Message Cookie law content: You can use either a simple text message for cookie law, or use an article to display the message. Accept Button Text The label of the accept button Read More Button TextThe text shown on the link to the cookie policy (requires Your Cookie Policy Link to be set) Cookie Policy link The url of the Cookie Policy. If left blank, the link will be hidden. Once the cookie law is enabled, you will have two options: Enter your cookie law notification message Use an article as cookie law: this option is perfect when you want to create a multilingual cookie law notification Using a simple cookie law message In the box Message, select Text Enter your cookie law notification message in the text box as well as config other params Using an article to display a cookie law message This option is important when you want to have a multi-lingual cookie law message To use this option, in the box Message -> Select Articles. Then browse the article that you want to use as your Cookie Law message Menu Assignment

61 This is where you assign the template style to specific menu items. All of your menu items will be listed here. After assigning the menu item for your template, click Save Assignment to save the settings. Import/Export The Sun Framework enables you to export and import your template settings. You can export all the setting that you configured to save as a backup file or reuse it somewhere. To import/export template settings, go to the top menu Maintenance select Import or Export Please note: When you import the backup file, your current template settings will be overwritten. Product Update JSN Template Update Notification Open a JSN template If the template is not updated, you will see a notification on the top bar like Update available for JSN XXX version Click on the Update button on the top right. Upon clicking the Update button, you will see the following screen if you have not set your token key for the template Click on Set Token Key button.

62 You will be redirected to the page Global Parameters - Token Key, where you will be asked to enter your JSN username and password and generate your Token key. Make sure that you have registered your domain. If not please follow the domain registration guidelines to complete the process, then get back to this step. Register your domain(s) Step 1: Log on JSN Customer Area Go to JoomlaShine website: ( Click on My Account menu on the top right Enter your Username & Password to log on the system

63 Step 2: Go to Order & Download section Step 3: Find your order(s) and register your domain(s) Click the Register button next to your order Type the domain(s) that you want to register and click the Register button next to your order. On this screen, you will see that all the domains that you register will be added and activated (the word activated is next to the domain names)

64 In case you want to deactivate a domain names from your list, simply click on the Deactivate now button Verify JSN template license The following steps are only applied for Shine and gen.2 templates, meaning that templates released from JSN Shine onward. Go to your template manager Click Global Parameters Select Token key Enter your JSN username & password Click Get token key This website uses cookies to ensure you get the best experience on our website. More information ( Got It!