x
Support Purchase
Metronic

The World’s #1 Bootstrap 4 HTML, Angular 8, React & VueJS

Admin Dashboard Theme Framework

 

Portlet

Overview

KTPortlet is a Metronic's custom plugin defined in [metronic]/theme/default/[demo]/src/assets/js/global/components/base/portlet.js.

Initialization

First parameter is the id, class, or tag of the HTML element. The second parameter is for the options.

 var portlet = new KTPortlet(id, options);
 var portlet = new KTPortlet('main_portlet', {
    bodyToggleSpeed: 400,
    tooltips: true,
    tools: {
        toggle: {
            collapse: 'Collapse',
            expand: 'Expand'
        },
        reload: 'Reload',
        remove: 'Remove',
        fullscreen: {
            on: 'Fullscreen',
            off: 'Exit Fullscreen'
        }
    },
    sticky: {
        offset: 300,
        zIndex: 101
    }
});

Options

var options = {
    bodyToggleSpeed: 400,
    tooltips: true,
    tools: {
        toggle: {
            collapse: 'Collapse',
            expand: 'Expand'
        },
        reload: 'Reload',
        remove: 'Remove',
        fullscreen: {
            on: 'Fullscreen',
            off: 'Exit Fullscreen'
        }
    },
    sticky: {
        offset: 300,
        zIndex: 101
    }
};
Field Type Description
bodyToggleSpeed number

Set the portlet body toggle speed in miliseconds

Sample 
bodyToggleSpeed: 400
tooltips boolean

Enable/disable portlet tooltips

Sample 
tooltips: true
tools.toggle object

Portlet toggle tools options. Set the title for the collapse and expand toggle.

Sample 
tools: {
    toggle: {
        collapse: 'Collapse',
        expand: 'Expand'
    }
}
tools.reload string

Set portlet reload title in the tools.

Sample 
tools: {
    reload: 'Reload',
}
tools.remove string

Set portlet remove title in the tools.

Sample 
tools: {
    remove: 'Remove',
}
tools.fullscreen object

Set portlet fullscreen title in the tools.

Sample 
tools: {
    fullscreen: {
        on: 'Fullscreen',
        off: 'Exit Fullscreen'
    }
}
sticky.offset number

Set the scroll offset for the sticky portlet header to appear.

Sample 
sticky: {
    offset: 300
}
sticky.zIndex number

Set the portlet sticky header z-index.

Sample 
sticky: {
    zIndex: 101
}

Attributes

<div class="kt-portlet">
	<div class="kt-portlet__head">
		<div class="kt-portlet__head-label">
			<h3 class="kt-portlet__head-title"><!-- head title here --></h3>
		</div>
	</div>
	<div class="kt-portlet__body">
		<div class="kt-section">
			<h3 class="kt-section__title"><!-- section title here --></h3>
			<div class="kt-section__info"><!-- info here --></div>
			<div class="kt-section__content kt-section__content--border">
			<!-- content here -->
			</div>
		</div>
	</div>
</div>
Atrribute Description
k-portlet-tool

Set an element in the portlet tools button to a specific action. Eg. <a href="#" kt-portlet-tool="remove">Remove</a>

Name Description
remove

Set remove portlet action
reload

Reload portlet
toggle

Toggle collapse and expand portlet
fullscreen

Toggle button to fullscreen portlet

API Methods

Method Description
setDefaults(options)

Set default options

Input Parameters
Name Type Description
options object

A new options object for the menu
setContent(contents)

Set dropdown content

Input Parameters
Name Type Description
contents string

Inner HTML to be placed in the dropdown content
remove()

Remove the portlet
reload()

Reload the portlet
toggle()

Toggle the portlet to collapse or expand
collapse()

Set portlet to collapse
expand()

Set portlet to expand
fullcreen()

Set portlet to fullscreen
unFullcreen()

Set portlet to default minimize
getBody()

Get the portlet body as HTML object
getSelf()

Get the portlet as HTML object
on(name, handler)

Register event

Input Parameters
Name Type Description
name string

Unique event name
handler function

Callback function handler for the event
one(name, handler)

Register event to be run once

Input Parameters
Name Type Description
name string

Unique event name
handler function

Callback function handler for the event
I run a team of 20 product managers, developers, QA and UX resources. Previously we designed everything ourselves. For our newest platform we tried out Metronic. I cannot overestimate the impact Metronic has had. It's accelerated development 3x and reduced QA issues by 50%. If you add up the reduced need for design time/resources, the increase in dev speed and the reduction in QA, it's probably saved us $100,000 on this project alone, and I plan to use it for all platforms moving forward.
The flexibility of the design has also allowed us to put out a better looking & working platform and reduced my headaches by 90%. Thank you KeenThemes! Jonathan Bartlett, Metronic Customer

Powerful Framework

Everything within Metronic is customizable globally to provide limitless unique styled projects

Multi Demo

Choose a perfect design for your next project among hundreds of demos

Limitless Components

A huge collection of components to power your application with the latest UI/UX trands

Angular 8 & React Support

Enterprise ready Angular and React integration with built-in authentication module and many more

Bootstrap 4

Metronic deeply customizes Bootstrap with native look and feel

Exclusive Datatable Plugin

Our super sleek and intuitive Datatable comes packed with all advanced CRUD features

75,000+ Strong

Metronic is the only theme trusted by over 70,000 developers world wide

Continuous Updates

Lifetime updates with new demos and features is guaranteed

Quality Code

Metronic is written with a code structure that all developers will be able to pick up easily and fall in love

The Ultimate Bootstrap Admin Theme Trusted By Over 70,000 Developers World Wide

PURCHASE NOW