\Kendo\UI\ButtonGroupItemBadge

A PHP class representing the badge setting of ButtonGroupItem.

Methods

appearance

Deprecated! Use items.badge.shape instead.For compatibility items.badge.appearance maps to items.badge.shape.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->appearance('value');
?>

badgeStyle

Specifies the structure of a badge. Valid options are solid (default) and outline.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->badgeStyle('value');
?>

color

Specifies the color of the component. Valid options are inherit, default, primary, secondary, tertiary, info, success, warning, error, dark, light, inverted.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->color('value');
?>

cutoutBorder

Specifies wether or not to render additional "cutout" border around the badge.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value boolean

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->cutoutBorder(true);
?>

icon

Defines the name for an existing icon in a Kendo UI theme or SVG content. The icon is rendered inside the badge by a span.k-icon or span.k-svg-icon element.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->icon('value');
?>

look

Deprecated! Use items.badge.badgeStyle instead.For compatibility badge.look maps to badge.badgeStyle.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->look('value');
?>

max

If text is a number, it will cap that number.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value float

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->max(1);
?>

overlay

Deprecated! Use items.badge.position instead.There is no built in mapping between items.badge.overlay and items.badge.position: items.badge.overlay: false can be achieved by setting items.badge.position: "inline" or items.badge.overlay: true can be achieved by setting items.badge.position: "top end", or not setting it at all.. For compatibility items.badge.overlay is kept, even though it has no effect on the badge.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value boolean

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->overlay(true);
?>

placement

Specifies position of the badge relative to the edge of the button. Valid placemnt options are: edge, inside, outside.Note: placement configuration requires the badge to be positioned. See items.badge.position for more details.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->placement('value');
?>

position

Specifies position of the badge relative to button. Valid position options are: inline, top start, top end, bottom start, bottom end. works in conjunction with items.badge.placement.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->position('value');
?>

shape

Specifies the shape of the badge. Valid options are: rectangle, rounded, pill, circle, dot.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->shape('value');
?>

size

Specifies the size of the badge. Valid options are small, medium and large.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->size('value');
?>

template

The template which renders the content of the badge.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->template('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->template(new \Kendo\JavaScriptFunction('function() { }'));
?>

text

The text of the badge. Valid input includes string, number or object with toString method. Default is empty string.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string|float

Example - using string

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->text('value');
?>

Example - using float

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->text(1);
?>

type

Deprecated! Use items.badge.color instead.For compatibility items.badge.type maps to items.badge.color.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->type('value');
?>

value

Deprecated! Use items.badge.text instead.For compatibility items.badge.value maps to items.badge.text.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value string|float

Example - using string

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->value('value');
?>

Example - using float

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->value(1);
?>

visible

If set to false the badge will not be displayed.

Returns

\Kendo\UI\ButtonGroupItemBadge

Parameters

$value boolean

Example

<?php
$badge = new \Kendo\UI\ButtonGroupItemBadge();
$badge->visible(true);
?>
In this article
Not finding the help you need?