| layout | post |
|---|---|
| title | Gallery in JavaScript Ribbon Control | Syncfusion |
| description | Learn here all about gallery support in Syncfusion JavaScript Ribbon control, it's elements, and more. |
| documentation | ug |
| platform | js |
| keywords | gallery,ribbon gallery |
| api | /api/js/ejribbon |
Galleries are used to display items that can be arranged in a grid-type layout. Items in the gallery can be customized as button/menu to display images, text, or both images and text. You can set type of group as gallery.
Gallery items are collection of the items to be included in the main gallery. You can set text and toolTip to gallery item which can also be customized with buttonSettings.
Number of columns to display in gallery for each row should be specified and the Number of columns in Expanded State (expandedColumns) can be customized, if not set, columns count will be set as default.
N> The itemHeight and itemWidth for gallery item can be set, if not set default values will be used.
{% highlight html %}
<div id="Ribbon"></div>
<ul id="ribbon">
<li><a>FILE</a>
<ul>
<li><a>Open</a></li>
</ul>
</li>
</ul>
<script type="text/javascript">
$(function () {
$("#Ribbon").ejRibbon({
width: "500",
applicationTab: {
type:ej.Ribbon.applicationTabType.menu,
menuItemID: "ribbon"
},
tabs: [{
id: "home",
text: "HOME",
groups: [{
type: "gallery",
text: "Gallery",
content: [{
groups: [{
id: "Gallery",
columns: 2,
itemHeight: 54,
itemWidth: 73,
expandedColumns: 3,
type: ej.Ribbon.type.gallery,
galleryItems: [{
text: "GalleryContent1",
toolTip: "GalleryContent1",
buttonSettings: {
contentType: ej.ContentType.ImageOnly,
prefixIcon: "e-icon e-gallerycontent1 e-gbtnimg",
cssClass: "e-gbtnposition"
}
}, {
text: "GalleryContent2",
toolTip: "GalleryContent2",
buttonSettings: {
contentType: ej.ContentType.ImageOnly,
prefixIcon: "e-icon e-gallerycontent2 e-gbtnimg",
cssClass: "e-gbtnposition"
}
}, {
text: "GalleryContent3",
toolTip: "GalleryContent3",
buttonSettings: {
contentType: ej.ContentType.ImageOnly,
prefixIcon: "e-icon e-gallerycontent3 e-gbtnimg",
cssClass: "e-gbtnposition"
}
}, {
text: "GalleryContent4",
toolTip: "GalleryContent4",
buttonSettings: {
contentType: ej.ContentType.ImageOnly,
prefixIcon: "e-icon e-gallerycontent4 e-gbtnimg",
cssClass: "e-gbtnposition"
}
}]
}]
}]
}]
}]
});
});
</script>
<style type="text/css">
.e-gallerycontent1 {
background-position: 0 -105px;
}
.e-gallerycontent2 {
background-position: -69px -105px;
}
.e-gallerycontent3 {
background-position: -136px -105px;
}
.e-gallerycontent4 {
background-position: 0 -53px;
}
.e-gbtnposition {
margin-top: 5px;
}
.e-gbtnimg {
background-image: url("../themes/common-images/ribbon/homegallery.png");
background-repeat: no-repeat;
height: 64px;
width: 64px;
}
</style>
{% endhighlight %}
Ribbon Gallery. {:.caption}
Gallery at Expanded State {:.caption}
Custom gallery items are the additional items to be displayed at gallery expanded state. You can set customItemType as button or menu, Default is button.
You can also set text and toolTip to custom gallery item which can also be customized with buttonSettings/menuSettings based on the customItemType specified.
{% highlight html %}
<div id="Ribbon"></div>
<ul id="ribbon">
<li><a>FILE</a> </li>
</ul>
<ul id="customMenu">
<li>
<a>New Quick Step</a>
<ul>
<li><a>Flag and Move</a></li>
</ul>
</li>
</ul>
<script type="text/javascript">
$(function () {
$("#Ribbon").ejRibbon({
width: "500",
applicationTab: {
type: ej.Ribbon.applicationTabType.menu,
menuItemID: "ribbon"
},
tabs: [{
id: "home",
text: "HOME",
groups: [{
type: "gallery",
text: "Gallery",
content: [{
groups: [{
id: "Gallery",
columns: 2,
itemHeight: 54,
itemWidth: 73,
expandedColumns: 3,
type: ej.Ribbon.type.gallery,
galleryItems: [{
text: "GalleryContent1",
toolTip: "GalleryContent1",
buttonSettings: {
contentType: ej.ContentType.ImageOnly,
prefixIcon: "e-icon e-gallerycontent1 e-gbtnimg",
cssClass: "e-gbtnposition"
}
}, {
text: "GalleryContent2",
toolTip: "GalleryContent2",
buttonSettings: {
contentType: ej.ContentType.ImageOnly,
prefixIcon: "e-icon e-gallerycontent2 e-gbtnimg",
cssClass: "e-gbtnposition"
}
}, {
text: "GalleryContent3",
toolTip: "GalleryContent3",
buttonSettings: {
contentType: ej.ContentType.ImageOnly,
prefixIcon: "e-icon e-gallerycontent3 e-gbtnimg",
cssClass: "e-gbtnposition"
}
}, {
text: "GalleryContent4",
toolTip: "GalleryContent4",
buttonSettings: {
contentType: ej.ContentType.ImageOnly,
prefixIcon: "e-icon e-gallerycontent4 e-gbtnimg",
cssClass: "e-gbtnposition"
}
}],
customGalleryItems: [{
customItemType: ej.Ribbon.customItemType.menu,
menuId: "customMenu",
menuSettings: {
openOnClick: false
}
}, {
text: "Clear Formatting",
toolTip: "Clear Formatting",
customItemType: ej.Ribbon.customItemType.button,
buttonSettings: {
cssClass: "e-extrabtnstyle"
}
}]
}]
}]
}]
}]
});
});
</script>
<style type="text/css">
.e-gallerycontent1 {
background-position: 0 -105px;
}
.e-gallerycontent2 {
background-position: -69px -105px;
}
.e-gallerycontent3 {
background-position: -136px -105px;
}
.e-gallerycontent4 {
background-position: 0 -53px;
}
.e-gbtnposition {
margin-top: 5px;
}
.e-gbtnimg {
background-image: url("../themes/common-images/ribbon/homegallery.png");
background-repeat: no-repeat;
height: 64px;
width: 64px;
}
.e-extracontent .e-extrabtnstyle {
padding-left: 28px;
text-align: left;
}
</style>
{% endhighlight %}
