Merge pull request #103 from willdale/add-localisation

Add Localization support
willdale · Jul 19, 2021 · eb5105f · eb5105f
2 parents 18eab2d + c9f08f0
commit eb5105f
Show file tree

Hide file tree

Showing 21 changed files with 135 additions and 97 deletions.
diff --git a/README.md b/README.md
@@ -536,26 +536,58 @@ struct LineChartDemoView: View {
 }
 ```
 
+# Accessibility
 
----
+Inside certain elements are additional tags to help describe the chart for VoiceOver.
 
+See [Localization of Accessibility](#Localization-of-Accessibility)
 
-FONTS
+# Localization
 
-Y Axis           - caption
-X Axis Title   - caption
-Y Axis Title   - caption
+All labels support localization. There are, however, some hidden labels that are there to support VoiceOver. See [Localization of Accessibility](#Localization-of-Accessibility)
 
-Header Box ------------------
+# Localization of Accessibility
 
-Chart Title      - title3 
-Chart Subtitle - subheadline
+See the localization demo in the [Demo Project](https://github.com/willdale/SwiftUICharts-Demo).
 
-Value           - title3
-Description - subheadline
+---
 
+Voice over description of a datapoint when the user touches the area closest to the data point.
+The VoiceOver will say `<chart title>, <data point value>, <data point description>`.
+```swift
+"%@ <local_description_of_a_data_point>" = "%@, <Description of a data point>";
+```
 
-Touch Overlay Box ------------------
 
-Description - subheadline
-Value           - title3
+Read out before a `poiMarker`.
+The VoiceOver will say `<p o i marker>, <marker legend title>, <marker value>`.
+```swift
+"P-O-I-Marker" = "P O I Marker";
+"Average" = "Average";
+```
+
+Voice over description of a `poiMarker`.
+The VoiceOver will say `<P-O-I-Marker>, <marker legend title>, <marker value>`.
+```swift
+"<local_marker_legend_title> %@" = "local_marker_legend_title, %@";
+```
+
+
+
+Read out before a `axisLabel`.
+The VoiceOver will say `<axisLabel>, <marker value>`.
+```
+"X-Axis-Label" = "X Axis Label";
+"Y-Axis-Label" = "Y Axis Label";
+```
+
+Read out before a `legend`.
+The VoiceOver will say `<chart type legend>, <legend title>`.
+```swift
+"Line-Chart-Legend" = "Line Chart Legend";
+"P-O-I-Marker-Legend" = "P O I Marker Legend";
+"Bar-Chart-Legend" = "Bar Chart Legend";
+"P-O-I-Marker-Legend" = "P O I Marker Legend";
+"Pie-Chart-Legend" = "Pie Chart Legend";
+"P-O-I-Marker-Legend" = "P O I Marker Legend";
+```
diff --git a/Sources/SwiftUICharts/BarChart/Models/ChartData/HorizontalBarChartData.swift b/Sources/SwiftUICharts/BarChart/Models/ChartData/HorizontalBarChartData.swift
@@ -72,12 +72,12 @@ public final class HorizontalBarChartData: CTHorizontalBarChartDataProtocol, Get
     public final func getXAxisLabels() -> some View {
         HStack(spacing: 0) {
             ForEach(self.labelsArray.indices, id: \.self) { i in
-                Text(self.labelsArray[i])
+                Text(LocalizedStringKey(self.labelsArray[i]))
                     .font(self.chartStyle.yAxisLabelFont)
                     .foregroundColor(self.chartStyle.yAxisLabelColour)
                     .lineLimit(1)
-                    .accessibilityLabel(Text("Y Axis Label"))
-                    .accessibilityValue(Text(self.labelsArray[i]))
+                    .accessibilityLabel(LocalizedStringKey("Y-Axis-Label"))
+                    .accessibilityValue(LocalizedStringKey(self.labelsArray[i]))
                     .overlay(
                         GeometryReader { geo in
                             Color.clear
@@ -133,7 +133,7 @@ public final class HorizontalBarChartData: CTHorizontalBarChartDataProtocol, Get
                         ForEach(labelArray, id: \.self) { data in
                             Spacer()
                                 .frame(minHeight: 0, maxHeight: 500)
-                            Text(data)
+                            Text(LocalizedStringKey(data))
                                 .font(self.chartStyle.xAxisLabelFont)
                                 .lineLimit(1)
                                 .foregroundColor(self.chartStyle.xAxisLabelColour)
@@ -146,8 +146,8 @@ public final class HorizontalBarChartData: CTHorizontalBarChartDataProtocol, Get
                                             }
                                     }
                                 )
-                                .accessibilityLabel(Text("X Axis Label"))
-                                .accessibilityValue(Text("\(data)"))
+                                .accessibilityLabel(LocalizedStringKey("Y-Axis-Label"))
+                                .accessibilityValue(LocalizedStringKey(data))
 
                             Spacer()
                                 .frame(minHeight: 0, maxHeight: 500)

diff --git a/Sources/SwiftUICharts/BarChart/Views/BarChart.swift b/Sources/SwiftUICharts/BarChart/Views/BarChart.swift
@@ -19,6 +19,7 @@ import SwiftUI
  ```
 
  # View Modifiers
+
  The order of the view modifiers is some what important
  as the modifiers are various types for stacks that wrap
  around the previous views.
@@ -58,10 +59,10 @@ public struct BarChart<ChartData>: View where ChartData: BarChartData {
                     switch chartData.barStyle.colourFrom {
                     case .barStyle:
                         BarChartBarStyleSubView(chartData: chartData)
-                            .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                            .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
                     case .dataPoints:
                         BarChartDataPointSubView(chartData: chartData)
-                            .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                            .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
                     }
                 }
                 // Needed for axes label frames

diff --git a/Sources/SwiftUICharts/BarChart/Views/GroupedBarChart.swift b/Sources/SwiftUICharts/BarChart/Views/GroupedBarChart.swift
@@ -120,7 +120,7 @@ internal struct GroupedBarCell<ChartData>: View where ChartData: GroupedBarChart
                 ColourBar(chartData: chartData,
                           dataPoint: dataPoint,
                           colour: colour)
-                    .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                    .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
             } else if dataPoint.group.colour.colourType == .gradientColour,
                       let colours = dataPoint.group.colour.colours,
                       let startPoint = dataPoint.group.colour.startPoint,
@@ -131,7 +131,7 @@ internal struct GroupedBarCell<ChartData>: View where ChartData: GroupedBarChart
                                    colours: colours,
                                    startPoint: startPoint,
                                    endPoint: endPoint)
-                    .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                    .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
             } else if dataPoint.group.colour.colourType == .gradientStops,
                       let stops = dataPoint.group.colour.stops,
                       let startPoint = dataPoint.group.colour.startPoint,
@@ -143,7 +143,7 @@ internal struct GroupedBarCell<ChartData>: View where ChartData: GroupedBarChart
                                  stops: safeStops,
                                  startPoint: startPoint,
                                  endPoint: endPoint)
-                    .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                    .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
             }
         }
     }

diff --git a/Sources/SwiftUICharts/BarChart/Views/HorizontalBarChart.swift b/Sources/SwiftUICharts/BarChart/Views/HorizontalBarChart.swift
@@ -24,10 +24,10 @@ public struct HorizontalBarChart<ChartData>: View where ChartData: HorizontalBar
                     switch chartData.barStyle.colourFrom {
                     case .barStyle:
                         HorizontalBarChartBarStyleSubView(chartData: chartData)
-                            .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                            .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
                     case .dataPoints:
                         HorizontalBarChartDataPointSubView(chartData: chartData)
-                            .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                            .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
                     }
 
                 }

diff --git a/Sources/SwiftUICharts/BarChart/Views/RangedBarChart.swift b/Sources/SwiftUICharts/BarChart/Views/RangedBarChart.swift
@@ -59,10 +59,10 @@ public struct RangedBarChart<ChartData>: View where ChartData: RangedBarChartDat
                     switch chartData.barStyle.colourFrom {
                     case .barStyle:
                         RangedBarChartBarStyleSubView(chartData: chartData)
-                            .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                            .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
                     case .dataPoints:
                         RangedBarChartDataPointSubView(chartData: chartData)
-                            .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                            .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
                     }
                 }
                 // Needed for axes label frames

diff --git a/Sources/SwiftUICharts/BarChart/Views/StackedBarChart.swift b/Sources/SwiftUICharts/BarChart/Views/StackedBarChart.swift
@@ -69,7 +69,7 @@ public struct StackedBarChart<ChartData>: View where ChartData: StackedBarChartD
                         .animateOnDisappear(using: chartData.chartStyle.globalAnimation) {
                             self.startAnimation = false
                         }
-                        .accessibilityLabel( Text("\(chartData.metadata.title)"))
+                        .accessibilityLabel(LocalizedStringKey(chartData.metadata.title))
                 }
             }
         } else { CustomNoDataView(chartData: chartData) }

diff --git a/Sources/SwiftUICharts/LineChart/Models/ChartData/MultiLineChartData.swift b/Sources/SwiftUICharts/LineChart/Models/ChartData/MultiLineChartData.swift
@@ -151,7 +151,7 @@ public final class MultiLineChartData: CTLineChartDataProtocol, GetDataProtocol,
                 AccessibilityRectangle(dataPointCount: dataSet.dataPoints.count,
                                        dataPointNo: point)
                     .foregroundColor(Color(.gray).opacity(0.000000001))
-                    .accessibilityLabel(Text("\(self.metadata.title)"))
+                    .accessibilityLabel(LocalizedStringKey(self.metadata.title))
                     .accessibilityValue(dataSet.dataPoints[point].getCellAccessibilityValue(specifier: self.infoView.touchSpecifier))
             }
         }

diff --git a/Sources/SwiftUICharts/LineChart/Models/Protocols/LineChartProtocolsExtensions.swift b/Sources/SwiftUICharts/LineChart/Models/Protocols/LineChartProtocolsExtensions.swift
@@ -630,7 +630,7 @@ extension CTLineChartDataProtocol where SetType: CTLineChartDataSet {
                                    dataPointNo: point)
 
                 .foregroundColor(Color(.gray).opacity(0.000000001))
-                .accessibilityLabel(Text("\(self.metadata.title)"))
+                .accessibilityLabel(LocalizedStringKey(self.metadata.title))
                 .accessibilityValue(self.dataSets.dataPoints[point].getCellAccessibilityValue(specifier: self.infoView.touchSpecifier))
         }
     }

diff --git a/Sources/SwiftUICharts/PieChart/Models/Protocols/PieChartProtocolsExtentions.swift b/Sources/SwiftUICharts/PieChart/Models/Protocols/PieChartProtocolsExtentions.swift
@@ -85,7 +85,7 @@ extension View {
                     case .none:
                         EmptyView()
                     case .label(let text, let colour, let font, let rFactor):
-                        Text(text)
+                        Text(LocalizedStringKey(text))
                             .font(font)
                             .foregroundColor(colour)
                             .position(chartData.getOverlayPosition(rect: rect,

diff --git a/Sources/SwiftUICharts/PieChart/Views/DoughnutChart.swift b/Sources/SwiftUICharts/PieChart/Views/DoughnutChart.swift
@@ -62,7 +62,7 @@ public struct DoughnutChart<ChartData>: View where ChartData: DoughnutChartData
                                 .zIndex(1)
                                 .shadow(color: Color.primary, radius: 10)
                         }
-                        .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                        .accessibilityLabel(chartData.metadata.title)
                         .accessibilityValue(chartData.dataSets.dataPoints[data].getCellAccessibilityValue(specifier: chartData.infoView.touchSpecifier))
                 }
             }

diff --git a/Sources/SwiftUICharts/PieChart/Views/PieChart.swift b/Sources/SwiftUICharts/PieChart/Views/PieChart.swift
@@ -59,7 +59,7 @@ public struct PieChart<ChartData>: View where ChartData: PieChartData {
                                 .zIndex(1)
                                 .shadow(color: Color.primary, radius: 10)
                         }
-                        .accessibilityLabel(Text("\(chartData.metadata.title)"))
+                        .accessibilityLabel(chartData.metadata.title)
                         .accessibilityValue(chartData.dataSets.dataPoints[data].getCellAccessibilityValue(specifier: chartData.infoView.touchSpecifier))
                 }
             }

diff --git a/Sources/SwiftUICharts/Shared/API.swift b/Sources/SwiftUICharts/Shared/API.swift
@@ -58,7 +58,7 @@ public struct InfoExtra<T>: View where T: CTChartData {
 
     public var body: some View {
         if chartData.infoView.isTouchCurrent {
-            Text(text)
+            Text(LocalizedStringKey(text))
         } else {
             EmptyView()
         }
@@ -87,7 +87,7 @@ extension LegendData {
                             LegendLine(width: width)
                                 .stroke(colour, style: strokeStyle)
                                 .frame(width: width, height: 3)
-                            Text(self.legend)
+                            Text(LocalizedStringKey(self.legend))
                                 .font(font)
                                 .foregroundColor(textColor)
                         }
@@ -99,7 +99,7 @@ extension LegendData {
                                                        endPoint: .trailing),
                                         style: strokeStyle)
                                 .frame(width: width, height: 3)
-                            Text(self.legend)
+                            Text(LocalizedStringKey(self.legend))
                                 .font(font)
                                 .foregroundColor(textColor)
                         }
@@ -112,7 +112,7 @@ extension LegendData {
                                                        endPoint: .trailing),
                                         style: strokeStyle)
                                 .frame(width: width, height: 3)
-                            Text(self.legend)
+                            Text(LocalizedStringKey(self.legend))
                                 .font(font)
                                 .foregroundColor(textColor)
                         }
@@ -126,7 +126,7 @@ extension LegendData {
                             Rectangle()
                                 .fill(colour)
                                 .frame(width: width / 2, height: width / 2)
-                            Text(self.legend)
+                            Text(LocalizedStringKey(self.legend))
                                 .font(font)
                         }
                     } else if let colours = self.colour.colours,
@@ -139,7 +139,7 @@ extension LegendData {
                                                      startPoint: startPoint,
                                                      endPoint: endPoint))
                                 .frame(width: width / 2, height: width / 2)
-                            Text(self.legend)
+                            Text(LocalizedStringKey(self.legend))
                                 .font(font)
                         }
                     } else if let stops = self.colour.stops,
@@ -153,7 +153,7 @@ extension LegendData {
                                                      startPoint: startPoint,
                                                      endPoint: endPoint))
                                 .frame(width: width / 2, height: width / 2)
-                            Text(self.legend)
+                            Text(LocalizedStringKey(self.legend))
                                 .font(font)
                         }
                     }
@@ -164,7 +164,7 @@ extension LegendData {
                         Circle()
                             .fill(colour)
                             .frame(width: width / 2, height: width / 2)
-                        Text(self.legend)
+                        Text(LocalizedStringKey(self.legend))
                             .font(font)
                     }
                 } else if let colours = self.colour.colours,
@@ -177,7 +177,7 @@ extension LegendData {
                                                  startPoint: startPoint,
                                                  endPoint: endPoint))
                             .frame(width: width / 2, height: width / 2)
-                        Text(self.legend)
+                        Text(LocalizedStringKey(self.legend))
                             .font(font)
                     }
 
@@ -192,7 +192,7 @@ extension LegendData {
                                                  startPoint: startPoint,
                                                  endPoint: endPoint))
                             .frame(width: width / 2, height: width / 2)
-                        Text(self.legend)
+                        Text(LocalizedStringKey(self.legend))
                             .font(font)
                     }
                 }
@@ -216,7 +216,7 @@ extension LegendData {
                     Circle()
                         .fill(colour)
                         .frame(width: width, height: width)
-                    Text(self.legend)
+                    Text(LocalizedStringKey(self.legend))
                         .font(font)
                         .foregroundColor(textColor)
                 }
@@ -227,7 +227,7 @@ extension LegendData {
                                              startPoint: .leading,
                                              endPoint: .trailing))
                         .frame(width: width, height: width)
-                    Text(self.legend)
+                    Text(LocalizedStringKey(self.legend))
                         .font(font)
                         .foregroundColor(textColor)
                 }
@@ -239,7 +239,7 @@ extension LegendData {
                                              startPoint: .leading,
                                              endPoint: .trailing))
                         .frame(width: width, height: width)
-                    Text(self.legend)
+                    Text(LocalizedStringKey(self.legend))
                         .font(font)
                         .foregroundColor(textColor)
                 }
@@ -251,21 +251,21 @@ extension LegendData {
         switch self.chartType {
         case .line:
             if self.prioity == 1 {
-                return "Line Chart Legend"
+                return "Line-Chart-Legend"
             } else {
-                return "P O I Marker Legend"
+                return "P-O-I-Marker-Legend"
             }
         case .bar:
             if self.prioity == 1 {
-                return "Bar Chart Legend"
+                return "Bar-Chart-Legend"
             } else {
-                return "P O I Marker Legend"
+                return "P-O-I-Marker-Legend"
             }
         case .pie:
             if self.prioity == 1 {
-                return "Pie Chart Legend"
+                return "Pie-Chart-Legend"
             } else {
-                return "P O I Marker Legend"
+                return "P-O-I-Marker-Legend"
             }
         }
     }