annotate README.md @ 131:ce6bfc2702fb default tip

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