react-okr-ui
Version:
A React user interface toolkit for building OKR centric applications.
733 lines (732 loc) • 18.6 kB
JSON
{
"config": {
"title": "OKR UI",
"description": "A React user interface toolkit for building OKR centric applications.",
"menu": [],
"version": "0.1.0",
"repository": null,
"native": false,
"themeConfig": {},
"separator": "-",
"dest": "/docs",
"files": "**/*.{markdown,mdx}"
},
"entries": [
{
"key": "src/docs/about.mdx",
"value": {
"title": "about",
"route": "/about",
"id": "96b11fc39a7f37472f1616ba0862866a",
"filepath": "src/docs/about.mdx",
"fullpath": "/Users/seanrioux/products/open-source-okr/code/react-okr-ui/src/docs/about.mdx",
"link": "",
"hidden": false,
"slug": "src-docs-about",
"name": "About",
"menu": "",
"headings": [
{
"slug": "about",
"depth": 1,
"value": "About"
},
{
"slug": "features",
"depth": 2,
"value": "Features"
},
{
"slug": "components",
"depth": 3,
"value": "Components"
},
{
"slug": "services",
"depth": 3,
"value": "Services"
},
{
"slug": "configuration",
"depth": 3,
"value": "Configuration"
},
{
"slug": "first-principles",
"depth": 2,
"value": "First principles"
}
]
}
},
{
"key": "src/docs/components.mdx",
"value": {
"title": "Components",
"route": "/components",
"id": "876604fb19e9e6dd3535044ab89e28dc",
"filepath": "src/docs/components.mdx",
"fullpath": "/Users/seanrioux/products/open-source-okr/code/react-okr-ui/src/docs/components.mdx",
"link": "",
"hidden": false,
"slug": "src-docs-components",
"name": "Components",
"menu": "",
"headings": [
{
"slug": "components",
"depth": 1,
"value": "Components"
},
{
"slug": "okr",
"depth": 2,
"value": "Okr"
},
{
"slug": "properties",
"depth": 3,
"value": "Properties"
},
{
"slug": "example-metrics-and-grades",
"depth": 4,
"value": "Example metrics and grades"
},
{
"slug": "objective",
"depth": 2,
"value": "Objective"
},
{
"slug": "properties-1",
"depth": 3,
"value": "Properties"
},
{
"slug": "result",
"depth": 2,
"value": "Result"
},
{
"slug": "properties-2",
"depth": 3,
"value": "Properties"
},
{
"slug": "goal",
"depth": 2,
"value": "Goal"
},
{
"slug": "properties-3",
"depth": 3,
"value": "Properties"
},
{
"slug": "due",
"depth": 2,
"value": "Due"
},
{
"slug": "progress",
"depth": 2,
"value": "Progress"
},
{
"slug": "properties-4",
"depth": 3,
"value": "Properties"
},
{
"slug": "results-example",
"depth": 3,
"value": "Results example"
},
{
"slug": "current",
"depth": 2,
"value": "Current"
},
{
"slug": "properties-5",
"depth": 3,
"value": "Properties"
},
{
"slug": "score",
"depth": 2,
"value": "Score"
},
{
"slug": "properties-6",
"depth": 3,
"value": "Properties"
},
{
"slug": "row",
"depth": 2,
"value": "Row"
},
{
"slug": "properties-7",
"depth": 3,
"value": "Properties"
}
]
}
},
{
"key": "src/docs/contribution.mdx",
"value": {
"title": "Contribution",
"route": "/contribution",
"id": "9900ee88efc5ce51b5f973385fc20ba2",
"filepath": "src/docs/contribution.mdx",
"fullpath": "/Users/seanrioux/products/open-source-okr/code/react-okr-ui/src/docs/contribution.mdx",
"link": "",
"hidden": false,
"slug": "src-docs-contribution",
"name": "Contribution",
"menu": "",
"headings": [
{
"slug": "contribution-guide",
"depth": 1,
"value": "Contribution guide"
},
{
"slug": "git",
"depth": 2,
"value": "Git"
},
{
"slug": "development",
"depth": 2,
"value": "Development"
},
{
"slug": "build",
"depth": 2,
"value": "Build"
}
]
}
},
{
"key": "src/docs/home.mdx",
"value": {
"title": "Home",
"route": "/",
"id": "e955be39a544e8cd7f90ce3094314f68",
"filepath": "src/docs/home.mdx",
"fullpath": "/Users/seanrioux/products/open-source-okr/code/react-okr-ui/src/docs/home.mdx",
"link": "",
"hidden": false,
"slug": "src-docs-home",
"name": "Home",
"menu": "",
"headings": [
{
"slug": "react-okr-ui",
"depth": 1,
"value": "React OKR UI"
},
{
"slug": "example",
"depth": 2,
"value": "Example"
},
{
"slug": "gettin-started",
"depth": 2,
"value": "Gettin Started"
}
]
}
}
],
"props": [
{
"key": "src/components/Current/index.js",
"value": [
{
"description": "",
"displayName": "Current",
"methods": [],
"actualName": "Current",
"props": {
"label": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"value": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"metricId": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
}
]
},
{
"key": "src/components/Due/index.js",
"value": [
{
"description": "",
"displayName": "Due",
"methods": [],
"actualName": "Due",
"props": {
"label": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"date": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"options": {
"type": {
"name": "shape",
"value": {
"weekday": {
"name": "string",
"required": false
},
"year": {
"name": "string",
"required": false
},
"month": {
"name": "string",
"required": false
},
"day": {
"name": "string",
"required": false
}
}
},
"required": false,
"description": ""
}
}
}
]
},
{
"key": "src/components/Goal/index.js",
"value": [
{
"description": "",
"displayName": "Goal",
"methods": [],
"actualName": "Goal",
"props": {
"label": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"text": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"direction": {
"type": {
"name": "enum",
"value": [
{
"value": "\"increase\"",
"computed": false
},
{
"value": "\"decrease\"",
"computed": false
},
{
"value": "\"maintain\"",
"computed": false
},
{
"value": "\"attain\"",
"computed": false
}
]
},
"required": false,
"description": ""
},
"metricId": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"start": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"end": {
"type": {
"name": "number"
},
"required": false,
"description": ""
}
}
}
]
},
{
"key": "src/components/Number/index.js",
"value": [
{
"description": "",
"displayName": "Number",
"methods": [],
"actualName": "Number"
}
]
},
{
"key": "src/components/Objective/index.js",
"value": [
{
"description": "",
"displayName": "Objective",
"methods": [],
"actualName": "Objective",
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
}
]
},
{
"key": "src/components/Okr/index.js",
"value": [
{
"description": "",
"displayName": "Okr",
"methods": [],
"actualName": "Okr",
"props": {
"metrics": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"id": {
"name": "string",
"required": false
},
"name": {
"name": "string",
"required": false
},
"prefix": {
"name": "string",
"required": false
},
"suffix": {
"name": "string",
"required": false
},
"space": {
"name": "bool",
"required": false
},
"allowNegative": {
"name": "bool",
"required": false
},
"decimalScale": {
"name": "number",
"required": false
}
}
}
},
"required": false,
"description": ""
},
"grades": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"id": {
"name": "string",
"required": false
},
"name": {
"name": "string",
"required": false
},
"range": {
"name": "arrayOf",
"value": {
"name": "number"
},
"required": false
},
"color": {
"name": "string",
"required": false
}
}
}
},
"required": false,
"description": ""
}
}
}
]
},
{
"key": "src/components/Progress/index.js",
"value": [
{
"description": "",
"displayName": "Progress",
"methods": [],
"actualName": "Progress",
"props": {
"label": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"value": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"results": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"id": {
"name": "string",
"required": false
},
"metricId": {
"name": "string",
"required": false
},
"direction": {
"name": "string",
"required": false
},
"start": {
"name": "number",
"required": false
},
"end": {
"name": "number",
"required": false
},
"current": {
"name": "number",
"required": false
}
}
}
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
}
]
},
{
"key": "src/components/Result/index.js",
"value": [
{
"description": "",
"displayName": "Result",
"methods": [],
"actualName": "Result",
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
}
]
},
{
"key": "src/components/Row/index.js",
"value": [
{
"description": "",
"displayName": "Row",
"methods": [],
"actualName": "Row",
"props": {
"kind": {
"type": {
"name": "enum",
"value": [
{
"value": "\"wrap\"",
"computed": false
},
{
"value": "\"flex\"",
"computed": false
}
]
},
"required": false,
"description": ""
}
}
}
]
},
{
"key": "src/components/Score/index.js",
"value": [
{
"description": "",
"displayName": "Score",
"methods": [],
"actualName": "Score",
"props": {
"label": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"direction": {
"type": {
"name": "enum",
"value": [
{
"value": "\"increase\"",
"computed": false
},
{
"value": "\"decrease\"",
"computed": false
},
{
"value": "\"maintain\"",
"computed": false
},
{
"value": "\"attain\"",
"computed": false
}
]
},
"required": false,
"description": ""
},
"start": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"end": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"current": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"circle": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
}
]
}
]
}