# UIStroke

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [UIComponent](https://rapi.sleaze.dev/classes/UIComponent.md), [UIBase](https://rapi.sleaze.dev/classes/UIBase.md), [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/UIStroke/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/UIStroke

Applies an outline to text or a UI border.

## Properties

### ApplyStrokeMode

```luau
UIStroke.ApplyStrokeMode: Enum.ApplyStrokeMode = Enum.ApplyStrokeMode.Contextual
```

- Tags: Read capabilities: UI

Determines whether to apply the stroke to the object's border instead of the text itself.

### BorderOffset

```luau
UIStroke.BorderOffset: UDim = UDim.new(0, 0)
```

- Tags: Read capabilities: UI

Specifies an additional offset to the stroke's position, relative to the parent's minimum height or width.

### BorderStrokePosition

```luau
UIStroke.BorderStrokePosition: Enum.BorderStrokePosition = Enum.BorderStrokePosition.Outer
```

- Tags: Read capabilities: UI

Determines the stroke's position on its parent's border.

### Color

```luau
UIStroke.Color: Color3 = Color3.new(0, 0, 0)
```

- Tags: Read capabilities: UI

Determines the stroke color.

### LineJoinMode

```luau
UIStroke.LineJoinMode: Enum.LineJoinMode = Enum.LineJoinMode.Round
```

- Tags: Read capabilities: UI

Determines how corners are interpreted.

### StrokeSizingMode

```luau
UIStroke.StrokeSizingMode: Enum.StrokeSizingMode = Enum.StrokeSizingMode.FixedSize
```

- Tags: Read capabilities: UI

Determines whether the stroke's [`Thickness`](https://rapi.sleaze.dev/classes/UIStroke.md) will be measured in pixels or be relative to the parent.

### Thickness

```luau
UIStroke.Thickness: number = 1
```

- Tags: Read capabilities: UI

Determines the stroke's thickness.

### Transparency

```luau
UIStroke.Transparency: number = 0
```

- Tags: Read capabilities: UI

Sets the stroke opacity independently of the parent object's `BackgroundTransparency` or `TextTransparency`.

### ZIndex

```luau
UIStroke.ZIndex: number = 1
```

- Tags: Read capabilities: UI

Determines the order in which the stroke renders relative to sibling [`UIStroke`](https://rapi.sleaze.dev/classes/UIStroke.md) instances.

### Enabled

```luau
UIStroke.Enabled: boolean = true
```

- Tags: Read capabilities: UI

Determines whether the stroke in visible.

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`