annotate README.md @ 117:7cdc06d6a9cc

Update README.md committer: GitHub <noreply@github.com>
author Dennis C. M. <dennis@denniscm.com>
date Mon, 09 Aug 2021 17:00:38 +0100
parents 0c0d38dca6d8
children 6d53542f6f9e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
79
1771c58c4abd Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 78
diff changeset
1 <a href="https://www.producthunt.com/posts/stockcharts-for-swiftui?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-stockcharts-for-swiftui" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=295975&theme=dark" alt="StockCharts for SwiftUI - Display interactive stock charts easily 🎉 | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
45
26a91d7ce85e Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 36
diff changeset
2
23
cf68e93882b4 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 22
diff changeset
3 # SwiftUI Stock Charts
117
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
4 ![Build Status](https://github.com/denniscm190/StockCharts/actions/workflows/swift.yml/badge.svg)
77
3d4c995845fd Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 60
diff changeset
5 Display interactive stock charts easily 🎉
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
6
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
7 ## Instalation
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
8 - In Xcode go to `File` -> `Swift packages` -> `Add package dependency`
22
5c9f74baee88 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 21
diff changeset
9 - Copy and paste `https://github.com/denniscm190/StockCharts.git`
6
9802bdd5c7f3 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 0
diff changeset
10
117
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
11 ## Demo app
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
12 [**Trades** is a SwiftUI app](https://github.com/denniscm190/trades-demo) with real use cases of the StockCharts `framework`.
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
13
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
14 ## Usage
36
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
15 ```swift
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
16 import StockCharts
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
17 ```
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
18
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
19 ### Line chart
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
20 ```swift
117
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
21 let lineChartController = LineChartController(prices: [Double])
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
22 LineChartView(lineChartController: lineChartController)
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
23 ```
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
24
117
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
25 You can customise the line chart with `LineChartController`
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
26
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
27 ```swift
117
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
28 LineChartController(
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
29 prices: [Double],
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
30 dates: [String],
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
31 hours: [String],
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
32 labelColor: Color,
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
33 indicatorPointColor: Color,
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
34 showingIndicatorLineColor: Color,
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
35 flatTrendLineColor: Color,
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
36 uptrendLineColor: Color,
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
37 downtrendLineColor: Color,
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
38 dragGesture: Bool
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
39 )
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
40 ```
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
41
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
42 To enable the drag gesture set `dragGesture` to `true` in the `LineChartController `
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
43
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
44 ```swift
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
45 LineChartView(
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
46 lineChartController:
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
47 LineChartController(
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
48 prices: [Double],
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
49 dragGesture: true
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
50 )
7cdc06d6a9cc Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 106
diff changeset
51 )
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
52 ```
59
e54c96a5c652 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 58
diff changeset
53 <img width="374" alt="LineChartVideo" src="https://user-images.githubusercontent.com/66180929/116899623-137c6e80-ac38-11eb-8ec0-e678aea54062.gif">
92
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
54
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
55 ### Capsule chart
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
56 ```swift
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
57 CapsuleChartView(percentageOfWidth: CGFloat)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
58 // percentageOfWidth: must be 0 <= x <= 1
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
59 ```
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
60
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
61 #### Example
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
62 ```swift
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
63 import SwiftUI
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
64 import StockCharts
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
65
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
66 struct ContentView: View {
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
67 var body: some View {
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
68 RoundedRectangle(cornerRadius: 25)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
69 .frame(width: 400, height: 120)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
70 .foregroundColor(.white)
106
0c0d38dca6d8 Change colours to native swiftUI
Dennis Concepción Martín <dennisconcepcionmartin@gmail.com>
parents: 92
diff changeset
71 .shadow(color: Color(,.gray).opacity(0.15), radius: 10)
92
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
72 .overlay(
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
73 VStack(alignment: .leading) {
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
74 Text("Dennis Concepcion")
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
75 .font(.title3)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
76 .fontWeight(.semibold)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
77
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
78 Text("Random guy")
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
79
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
80 CapsuleChartView(percentageOfWidth: 0.6)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
81 .padding(.top)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
82 }
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
83 .padding()
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
84 )
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
85 }
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
86 }
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
87 ```
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
88
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
89 <img width="328" alt="CapsuleChart" src="https://user-images.githubusercontent.com/66180929/120899384-c2450d80-c62f-11eb-9a56-5a03e97441d2.png">
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
90