A button that displays a single icon, designed for compact, icon-only interactions such as toolbar actions, floating action buttons, or inline controls. The icon is sourced from the icon registry via the name and collection attributes. Like the normal button, it can render as an anchor element when href is set and is fully form-associated. accessibility or augmented layouts.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbIconButton()Returns IgbIconButton
Properties
Section titled "Properties"DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbButtonBase
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }DisplayType
Section titled "DisplayType"Inherited from: IgbButtonBase
The type of the button, which determines its behavior and semantics. 'button' – no default action; useful for custom JavaScript handlers. 'submit' – submits the associated form when clicked. 'reset' – resets the associated form fields to their initial values. Ignored when the button is rendered as a link (i.e. href is set). 'button'
[Parameter]
[WCWidgetMemberName("Type")]
public ButtonBaseType DisplayType { get; set; }Inherited from: IgbButtonBase
[Parameter]
public string Href { get; set; }Download
Section titled "Download"Inherited from: IgbButtonBase
Prompts the browser to download the linked resource rather than navigating to it. The optional value is used as the suggested file name. Only effective when href is set.
[Parameter]
public string Download { get; set; }Target
Section titled "Target"Inherited from: IgbButtonBase
Where to open the linked document. Only effective when href is set. '_self' – current browsing context (default browser behavior). '_blank' – new tab or window. '_parent' – parent browsing context; falls back to _self if none. '_top' – top-level browsing context; falls back to _self if none.
[Parameter]
public ButtonBaseTarget Target { get; set; }Inherited from: IgbButtonBase
The relationship between the current document and the linked URL. Accepts a space-separated list of link types (e.g. 'noopener noreferrer'). Only effective when href is set. When target="_blank" is used, setting rel="noopener noreferrer" is strongly recommended for security.
[Parameter]
public string Rel { get; set; }Disabled
Section titled "Disabled"Inherited from: IgbButtonBase
When set, the button will be disabled and non-interactive. false
[Parameter]
public bool Disabled { get; set; }Command
Section titled "Command"Inherited from: IgbButtonBase
The command to invoke on the target element specified by commandfor. Part of the Invoker Commands API. Custom commands must start with two dashes (e.g. '--my-command').
[Parameter]
public string Command { get; set; }Commandfor
Section titled "Commandfor"Inherited from: IgbButtonBase
The ID of the target element for the invoker command. Part of the Invoker Commands API.
[Parameter]
public string? Commandfor { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererControl
protected virtual string ParentTypeName { get; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }Collection
Section titled "Collection"The collection the icon belongs to.
[Parameter]
public string Collection { get; set; }DirectRenderElementName
Section titled "DirectRenderElementName"protected override string DirectRenderElementName { get; }IconName
Section titled "IconName"The name of the icon to display.
[Parameter]
[WCWidgetMemberName("Name")]
public string IconName { get; set; }Mirrored
Section titled "Mirrored"Determines whether the icon should be mirrored in right-to-left contexts. false
[Parameter]
public bool Mirrored { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }public override string Type { get; }UseDirectRender
Section titled "UseDirectRender"protected override bool UseDirectRender { get; }Variant
Section titled "Variant"The variant of the button which determines its visual appearance. contained – filled background; highest visual emphasis (default). outlined – transparent background with a visible border. flat – no background or border; lowest visual emphasis. 'contained'
[Parameter]
public IconButtonVariant Variant { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"FocusComponentAsync(IgbFocusOptions)
Section titled "FocusComponentAsync(IgbFocusOptions)"Inherited from: IgbButtonBase
Sets focus in the button.
[WCWidgetMemberName("Focus")]
public Task FocusComponentAsync(IgbFocusOptions options)Parameters
- options:
IgbFocusOptions
Returns any
FocusComponent(IgbFocusOptions)
Section titled "FocusComponent(IgbFocusOptions)"Inherited from: IgbButtonBase
[WCWidgetMemberName("Focus")]
public void FocusComponent(IgbFocusOptions options)Parameters
- options:
IgbFocusOptions
Returns any
BlurComponentAsync()
Section titled "BlurComponentAsync()"Inherited from: IgbButtonBase
Removes focus from the button.
[WCWidgetMemberName("Blur")]
public Task BlurComponentAsync()Returns any
BlurComponent()
Section titled "BlurComponent()"Inherited from: IgbButtonBase
[WCWidgetMemberName("Blur")]
public void BlurComponent()Returns any
SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbButtonBase
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbButtonBase
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
ClickAsync()
Section titled "ClickAsync()"Inherited from: IgbButtonBase
Simulates a mouse click on the button, triggering its click handler and any associated form action.
public Task ClickAsync()Returns any
Click()
Section titled "Click()"Inherited from: IgbButtonBase
public void Click()Returns any
ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
RegisterIcon(string, string, string)
Section titled "RegisterIcon(string, string, string)"public void RegisterIcon(string name, string url, string collection = null)Parameters
- name:
string - url:
string - collection:
string
Returns any
RegisterIconAsync(string, string, string)
Section titled "RegisterIconAsync(string, string, string)"public Task RegisterIconAsync(string name, string url, string collection = null)Parameters
- name:
string - url:
string - collection:
string
Returns any
RegisterIconFromText(string, string, string)
Section titled "RegisterIconFromText(string, string, string)"public void RegisterIconFromText(string name, string iconText, string collection = null)Parameters
- name:
string - iconText:
string - collection:
string
Returns any
RegisterIconFromTextAsync(string, string, string)
Section titled "RegisterIconFromTextAsync(string, string, string)"public Task RegisterIconFromTextAsync(string name, string iconText, string collection = null)Parameters
- name:
string - iconText:
string - collection:
string
Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
Events
Section titled "Events"Focus
Section titled "Focus"[Parameter]
public EventCallback<IgbVoidEventArgs> Focus { get; set; }[Parameter]
public EventCallback<IgbVoidEventArgs> Blur { get; set; }FocusScript
Section titled "FocusScript"[Parameter]
public string FocusScript { get; set; }BlurScript
Section titled "BlurScript"[Parameter]
public string BlurScript { get; set; }