Merge pull request #6 from artstorm/update-docs

Update docs

Author: artstorm

.github/readme/ui-builder-inspector.png

@@ -21,7 +21,7 @@ public override string ToString()
 
         public new class UxmlFactory : UxmlFactory<SafeArea, UxmlTraits> {}
 
-        public bool CollapseMargin { get; set; }
+        public bool CollapseMargins { get; set; }
         public bool ExcludeLeft { get; set; }
         public bool ExcludeRight { get; set; }
         public bool ExcludeTop { get; set; }
@@ -30,7 +30,7 @@ public override string ToString()
 
         public new class UxmlTraits : VisualElement.UxmlTraits
         {
-            private UxmlBoolAttributeDescription _collapseMarginAttr = new() { name = "collapse-margin", defaultValue = true };
+            private UxmlBoolAttributeDescription _collapseMarginsAttr = new() { name = "collapse-margins", defaultValue = true };
             private UxmlBoolAttributeDescription _excludeLeftAttr = new() { name = "exclude-left", defaultValue = false };
             private UxmlBoolAttributeDescription _excludeRightAttr = new() { name = "exclude-right", defaultValue = false };
             private UxmlBoolAttributeDescription _excludeTopAttr = new() { name = "exclude-top", defaultValue = false };
@@ -47,7 +47,7 @@ public override void Init(VisualElement ve, IUxmlAttributes bag, CreationContext
                 base.Init(ve, bag, cc);
                 var ate = ve as SafeArea;
 
-                ate.CollapseMargin = _collapseMarginAttr.GetValueFromBag(bag, cc);
+                ate.CollapseMargins = _collapseMarginsAttr.GetValueFromBag(bag, cc);
                 ate.ExcludeLeft = _excludeLeftAttr.GetValueFromBag(bag, cc);
                 ate.ExcludeRight = _excludeRightAttr.GetValueFromBag(bag, cc);
                 ate.ExcludeTop = _excludeTopAttr.GetValueFromBag(bag, cc);
@@ -88,7 +88,7 @@ private void OnGeometryChanged(GeometryChangedEvent evt)
                 var safeArea = GetSafeAreaOffset();
                 var margin = GetMarginOffset();
 
-                if (CollapseMargin)
+                if (CollapseMargins)
                 {
                     _contentContainer.style.marginLeft = Mathf.Max(margin.Left, safeArea.Left) - margin.Left;
                     _contentContainer.style.marginRight = Mathf.Max(margin.Right, safeArea.Right) - margin.Right;

Packages/com.bitbebop.ui-toolkit-safe-area/Runtime/SafeArea.cs

@@ -20,7 +20,9 @@
 
 The goal of the safe area container is to provide a custom control to simplify handling safe areas with UI Toolkit on relevant devices.
 
-- Optional safe area and margin collapse.
+- Option to collapse margins with the safe area.
+- Option to exclude specific safe area edges.
+- Option to exclude safe area on tvOS.
 
 ## Usage
 
@@ -30,19 +32,31 @@ The SafeArea container is available in the Library in UI Builder and can be foun
 
 The SafeArea container should be added as the top element in the hierarchy to ensure that it can fill up the entire screen. All child elements dropped into the SafeArea container will live inside `safe-area-content-container` and be adjusted accordingly depending on the current device SafeArea.
 
-Margins can be set on the SafeArea container, useful when running on devices that does not utilize a safe area.
+Margins can be set on the SafeArea container, which can be useful when running on devices that does not utilize a safe area.
 
-The container margins and the safe area is collapsed by default. That can be disabled in the inspector.
+The SafeArea container has a selection of custom attributes that can be set in the UI Builder inspector.
 
 ![UI Builder Inspector](https://raw.githubusercontent.com/artstorm/ui-toolkit-safe-area/main/.github/readme/ui-builder-inspector.png)
 
+### Collapse Margins
+
+The container margins and the safe area is collapsed by default. That can be disabled in the inspector.
+
 Take a look at these screenshots which helps illustrate the differences how margin, safe area and collapse comes together. In each example the margin is set to `10px 10px 0px 10px`.
 
 ![UI Builder Inspector](https://raw.githubusercontent.com/artstorm/ui-toolkit-safe-area/main/.github/readme/collapse-margin.png)
 
 1. For a device without a safe area, the margin values are used as-is and collapse margins doesn't play a part as there is no safe area to collapse with.
 2. For a device with a safe area the margins are collapsed with the safe area. The margin value is used if it would be larger than the safe area.
-3. If `Collapse Margin` is disabled, the margin is added to the safe area.
+3. If `Collapse Margins` is disabled, the margin is added to the safe area.
+
+### Exclude Edges
+
+With exclude edges, the safe area value of `left`, `right`, `top` and `bottom` edges can optionally be excluded from the calculations. If an edge is excluded, only the margin value for that edge will be used.
+
+### Exclude tvOS
+
+This option excludes the safe area values for all edges on tvOS. If selected, tvOS builds will not use safe area but only the margin values.
 
 ## Installation