Skip to content

Commit e455c36

Browse files
farfromrefugfarfromrefug
committed
readme/doc
1 parent 5db6f30 commit e455c36

File tree

7 files changed

+438
-124
lines changed

7 files changed

+438
-124
lines changed

‎README.md‎

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,200 @@
11
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->This monorepo contains multiple packages:<br><br>
22
<details open>
3+
<summary><b>alignedflowlayout</b></summary>
4+
5+
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
6+
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
8+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
13+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
14+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
15+
DO NOT EDIT THIS READEME DIRECTLY! Edit "bluesprint.md" instead.
16+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
17+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
18+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
19+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
20+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
21+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
22+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
23+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
24+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
25+
<h1 align="center">@nativescript-community/ui-collectionview-alignedflowlayout</h1>
26+
<p align="center">
27+
<a href="https://npmcharts.com/compare/@nativescript-community/ui-collectionview-alignedflowlayout?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/@nativescript-community/ui-collectionview-alignedflowlayout.svg" height="20"/></a>
28+
<a href="https://www.npmjs.com/package/@nativescript-community/ui-collectionview-alignedflowlayout"><img alt="NPM Version" src="https://img.shields.io/npm/v/@nativescript-community/ui-collectionview-alignedflowlayout.svg" height="20"/></a>
29+
</p>
30+
31+
<p align="center">
32+
<b>A NativeScript CollectionView For Custom aligned Layout Plugin.</b></br>
33+
<sub><sub>
34+
</p>
35+
36+
<br />
37+
38+
39+
40+
[](#table-of-contents)
41+
42+
43+
[](#table-of-contents)
44+
45+
## Table of Contents
46+
47+
* [Installation](#installation)
48+
* [Configuration](#configuration)
49+
* [Demos and Development](#demos-and-development)
50+
* [Repo Setup](#repo-setup)
51+
* [Build](#build)
52+
* [Demos](#demos)
53+
* [Contributing](#contributing)
54+
* [Update repo ](#update-repo-)
55+
* [Update readme ](#update-readme-)
56+
* [Update doc ](#update-doc-)
57+
* [Publish](#publish)
58+
* [modifying submodules](#modifying-submodules)
59+
* [Questions](#questions)
60+
61+
62+
[](#installation)
63+
64+
65+
[](#installation)
66+
67+
## Installation
68+
Run the following command from the root of your project:
69+
70+
`ns plugin add @nativescript-community/ui-collectionview-alignedflowlayout`
71+
72+
73+
[](#configuration)
74+
75+
76+
[](#configuration)
77+
78+
## Configuration
79+
80+
To install the plugin run:
81+
```typescript
82+
import install from '@nativescript-community/ui-collectionview-alignedflowlayout';
83+
install();
84+
```
85+
86+
then simply use the `layoutStyle="align"` as a collectionview property
87+
You can then use `layoutHorizontalAlignment`(left, right, justified) and `verticalHorizontalAlignment` (top, bottom, center)
88+
89+
90+
[](#demos-and-development)
91+
92+
93+
[](#demos-and-development)
94+
95+
## Demos and Development
96+
97+
98+
### Repo Setup
99+
100+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
101+
```
102+
git submodule update --init
103+
```
104+
105+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
106+
107+
To develop and test:
108+
if you use `yarn` then run `yarn`
109+
if you use `pnpm` then run `pnpm i`
110+
111+
**Interactive Menu:**
112+
113+
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
114+
115+
### Build
116+
117+
```bash
118+
npm run build.all
119+
```
120+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
121+
122+
### Demos
123+
124+
```bash
125+
npm run demo.[ng|react|svelte|vue].[ios|android]
126+
127+
npm run demo.svelte.ios # Example
128+
```
129+
130+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
131+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
132+
You can start from the `install.ts` of each flavor to see how to register new demos
133+
134+
135+
[](#contributing)
136+
137+
138+
[](#contributing)
139+
140+
## Contributing
141+
142+
### Update repo
143+
144+
You can update the repo files quite easily
145+
146+
First update the submodules
147+
148+
```bash
149+
npm run update
150+
```
151+
152+
Then commit the changes
153+
Then update common files
154+
155+
```bash
156+
npm run sync
157+
```
158+
Then you can run `yarn|pnpm`, commit changed files if any
159+
160+
### Update readme
161+
```bash
162+
npm run readme
163+
```
164+
165+
### Update doc
166+
```bash
167+
npm run doc
168+
```
169+
170+
### Publish
171+
172+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
173+
Simply run
174+
```shell
175+
npm run publish
176+
```
177+
178+
### modifying submodules
179+
180+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
181+
One easy solution is t modify `~/.gitconfig` and add
182+
```
183+
[url "ssh://[email protected]/"]
184+
pushInsteadOf = https://github.com/
185+
```
186+
187+
188+
[](#questions)
189+
190+
191+
[](#questions)
192+
193+
## Questions
194+
195+
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
196+
</details>
197+
<details open>
3198
<summary><b>collectionview</b></summary>
4199

5200
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->

‎docs/assets/highlight.css‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
:root {
2-
--light-hl-0: #0000FF;
3-
--dark-hl-0: #569CD6;
2+
--light-hl-0: #AF00DB;
3+
--dark-hl-0: #C586C0;
44
--light-hl-1: #000000;
55
--dark-hl-1: #D4D4D4;
6-
--light-hl-2: #0070C1;
7-
--dark-hl-2: #4FC1FF;
8-
--light-hl-3: #001080;
9-
--dark-hl-3: #9CDCFE;
10-
--light-hl-4: #098658;
11-
--dark-hl-4: #B5CEA8;
12-
--light-hl-5: #A31515;
13-
--dark-hl-5: #CE9178;
14-
--light-hl-6: #008000;
15-
--dark-hl-6: #6A9955;
16-
--light-hl-7: #800000;
17-
--dark-hl-7: #808080;
18-
--light-hl-8: #800000;
19-
--dark-hl-8: #569CD6;
20-
--light-hl-9: #E50000;
21-
--dark-hl-9: #9CDCFE;
22-
--light-hl-10: #0000FF;
23-
--dark-hl-10: #CE9178;
24-
--light-hl-11: #AF00DB;
25-
--dark-hl-11: #C586C0;
26-
--light-hl-12: #795E26;
27-
--dark-hl-12: #DCDCAA;
28-
--light-hl-13: #267F99;
29-
--dark-hl-13: #4EC9B0;
30-
--light-hl-14: #CD3131;
31-
--dark-hl-14: #F44747;
32-
--light-hl-15: #000000FF;
33-
--dark-hl-15: #D4D4D4;
34-
--light-hl-16: #000000;
35-
--dark-hl-16: #C8C8C8;
6+
--light-hl-2: #001080;
7+
--dark-hl-2: #9CDCFE;
8+
--light-hl-3: #A31515;
9+
--dark-hl-3: #CE9178;
10+
--light-hl-4: #795E26;
11+
--dark-hl-4: #DCDCAA;
12+
--light-hl-5: #008000;
13+
--dark-hl-5: #6A9955;
14+
--light-hl-6: #000000;
15+
--dark-hl-6: #C8C8C8;
16+
--light-hl-7: #0000FF;
17+
--dark-hl-7: #569CD6;
18+
--light-hl-8: #0070C1;
19+
--dark-hl-8: #4FC1FF;
20+
--light-hl-9: #098658;
21+
--dark-hl-9: #B5CEA8;
22+
--light-hl-10: #800000;
23+
--dark-hl-10: #808080;
24+
--light-hl-11: #800000;
25+
--dark-hl-11: #569CD6;
26+
--light-hl-12: #E50000;
27+
--dark-hl-12: #9CDCFE;
28+
--light-hl-13: #0000FF;
29+
--dark-hl-13: #CE9178;
30+
--light-hl-14: #267F99;
31+
--dark-hl-14: #4EC9B0;
32+
--light-hl-15: #CD3131;
33+
--dark-hl-15: #F44747;
34+
--light-hl-16: #000000FF;
35+
--dark-hl-16: #D4D4D4;
3636
--light-code-background: #FFFFFF;
3737
--dark-code-background: #1E1E1E;
3838
}

‎docs/assets/navigation.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)