annotate README.md @ 129:b8549a53d732

Add images to readme
author Dennis C. M. <dennis@denniscm.com>
date Wed, 20 Nov 2024 09:06:16 +0000
parents 212573e8b5d4
children ce6bfc2702fb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
127
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents: 125
diff changeset
1
128
212573e8b5d4 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 127
diff changeset
2 # stock-charts
127
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents: 125
diff changeset
3
129
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
4 <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>
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
5
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
6 This project is now deprecated in favor of the [Apple’s native framework](https://developer.apple.com/documentation/charts). At the time of archiving this project, it has accumulated 98 stars and 11 forks on Github.
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
7
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
8 StockCharts is a library to create intertactive charts in SwiftUI.
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
9
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
10 ## Installation
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
11 In Xcode go to File -> Swift packages -> Add package dependency
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
12 Copy and paste https://github.com/denniscmartin/stock-charts.git
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
13 I’ve created a demo app using StockCharts called Trades. Check out the code in my Github
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
14
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
15 ## Usage
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
16
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
17 ```swift
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
18 import StockCharts
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
19 ```
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
20
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
21 ### Line chart
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
22
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
23 ```swift
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
24 let lineChartController = LineChartController(prices: [Double])
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
25 LineChartView(lineChartController: lineChartController)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
26 ```
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
27
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
28 You can customise the line chart with LineChartController
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
29
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
30 ```swift
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
31 LineChartController(
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
32 prices: [Double],
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
33 dates: [String]?, // format: yy-MM-dd
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
34 hours: [String]?, // has to correspond to dates
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
35 labelColor: Color,
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
36 indicatorPointColor: Color,
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
37 showingIndicatorLineColor: Color,
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
38 flatTrendLineColor: Color,
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
39 uptrendLineColor: Color,
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
40 downtrendLineColor: Color,
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
41 dragGesture: Bool
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
42 )
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
43 ```
127
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents: 125
diff changeset
44
129
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
45 To enable the drag gesture set dragGesture to true in the LineChartController
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
46
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
47 ```swift
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
48 LineChartView(
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
49 lineChartController:
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
50 LineChartController(
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
51 prices: [Double],
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
52 dragGesture: true
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
53 )
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
54 )
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
55 ```
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
56
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
57 ### Capsule chart
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
58
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
59 ```swift
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
60 CapsuleChartView(percentageOfWidth: CGFloat)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
61 // percentageOfWidth: must be 0 <= x <= 1
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
62 import SwiftUI
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
63 import StockCharts
127
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents: 125
diff changeset
64
129
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
65 struct ContentView: View {
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
66 var body: some View {
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
67 RoundedRectangle(cornerRadius: 25)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
68 .frame(width: 400, height: 120)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
69 .foregroundColor(.white)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
70 .shadow(color: Color(.gray).opacity(0.15), radius: 10)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
71 .overlay(
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
72 VStack(alignment: .leading) {
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
73 Text("Dennis Concepcion")
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
74 .font(.title3)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
75 .fontWeight(.semibold)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
76
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
77 Text("Random guy")
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
78
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
79 CapsuleChartView(percentageOfWidth: 0.6, style: CapsuleChartStyle(capsuleColor: Color.blue))
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
80 .padding(.top)
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
81 }
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
82 .padding()
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
83 )
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
84 }
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
85 }
b8549a53d732 Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 128
diff changeset
86 ```