- Notifications
You must be signed in to change notification settings - Fork5
ollionorg/flow-core
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Flow-core is the base library required by any flow dependecies. It consists mostly of building blocks such design + system tokens, atoms, molecules, base themes, etc.
- Starter-kits
- Install for an existing project
- VScode Plugin and debuggers
- Components
- Templates
- Resources
- Figma for designers
- Get in touch
For a new project, Flow has put together starter kits with basic dependencies to get you going. Each starter kit will contain Flow core,Flow system icons, Default google fonts and fully functional Flow templates (eg: top navigation, profile, left navigation, etc)
If you would like to contribute to an existing starter kit or write a new one for a different framework, write toflow@ollion.com or ping on our slack channel.
VScode Plugin:Install Flow's Plugin to access components, icons, values, etc, and documentation inside of VScode.
Browser Debugger:Chrome,Firefox,Safari
Note: For Typescript, make sure you are using version >4.5
npm i --save @ollion/flow-core
Note: after installation re-start your application.
Copy and import the below snippet into your startup file. InVueJS: (src/main.ts or main.js),Angular: (src/main.ts),React: (src/index.tsx or index.jsx)
import"@ollion/flow-core";
Vue:Copy paste below line in yourmain.ts
file.
import"@ollion/flow-core/dist/types/vue2";
or
import"@ollion/flow-core/dist/types/vue3";
ReactInclude react type intsconfig.json
like below
"include": ["src","./node_modules/@ollion/flow-core/dist/types/react.ts"]
Note: after adding the snippets, re-start your application.
Icons are not packaged with Flow core to allow more flexibility and customization. We recommend that you install the system icon pack to get started.
npm i --save @ollion/flow-system-icon
import"@ollion/flow-core";import"@ollion/flow-system-icon";
Install Flow's Plugin to access components, icons, values, etc, and documentation inside of VScode.
Browser Debugger:Chrome,Firefox,Safari
Visit theFlow components Storybook
Visit theFlow templates Storybook
- Tables (In development)
- Logs (coming soon)
- Force graph (coming soon)
- Themes (coming soon)
- Time-series (coming soon)
If you would like to get in touch or contribute, please write toflow@ollion.com.
About
Flow