Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Complete Documentation Rewrite #2108

Merged
merged 130 commits into from
Mar 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
130 commits
Select commit Hold shift + click to select a range
8d82b59
chore: Convert stories to current Storybook format
cutterbl Jan 4, 2022
63edd57
chore: Adding prop stories
cutterbl Jan 6, 2022
3bb9ea3
docs: Additional props stories
cutterbl Jan 8, 2022
cb74d7c
docs: Add more props
cutterbl Jan 9, 2022
8693a0b
docs: Continuing additions
cutterbl Jan 10, 2022
19333d1
docs: Cleanup work
cutterbl Jan 11, 2022
13d134a
docs: Continue with props
cutterbl Jan 12, 2022
6397afb
docs: Continued props documentation
cutterbl Jan 13, 2022
e948c33
docs: Beginning Examples documentation
cutterbl Jan 16, 2022
213da45
docs: Continuing Examples
cutterbl Jan 17, 2022
64b2499
docs: Begin Drag and Drop documentation
cutterbl Jan 18, 2022
f90be5d
docs: Continuing documentation
cutterbl Jan 19, 2022
e8e697b
docs: Beginning DnD props docs
cutterbl Jan 19, 2022
27b7273
docs: Wrap up documentation
cutterbl Jan 20, 2022
9b4ab8c
docs: Add a little more
cutterbl Jan 20, 2022
e12d3e0
docs: Polish
cutterbl Jan 20, 2022
6fbfb1f
ci: Update to SB release
cutterbl Jan 20, 2022
955b55e
ci: Correct folder name
cutterbl Jan 20, 2022
105dfb7
docs: Continued refinement
cutterbl Jan 21, 2022
09e40c4
chore: Remove old Examples
cutterbl Jan 21, 2022
009b957
chore: Resolve merge conflicts
cutterbl Jan 22, 2022
b66fb6d
chore: Updated yarn.lock
cutterbl Jan 22, 2022
e3d96e5
fix: Correct DragAndDrop event resizing in 'month' view
Jan 25, 2022
14f060c
chore(release): set `package.json` to 0.38.6 [skip ci]
semantic-release-bot Jan 25, 2022
bd8e0e9
fix: Correct display of beginning DST
cutterbl Feb 3, 2022
cb3556b
chore(release): set `package.json` to 0.38.7 [skip ci]
semantic-release-bot Feb 3, 2022
19294de
fix: Correct variable name that gets passed on to EventWrapper so dra…
dhruvgoel92 Feb 10, 2022
6d00f12
chore(release): set `package.json` to 0.38.8 [skip ci]
semantic-release-bot Feb 10, 2022
c3f25eb
fix: Correct no overlap algorithm stretch behavior (#2120)
matmello Feb 10, 2022
16abd13
chore(release): set `package.json` to 0.38.9 [skip ci]
semantic-release-bot Feb 10, 2022
6f000d4
chore: Update bootstrap-sass (#2136)
cutterbl Feb 28, 2022
aa8f374
feat: Disable autoscroll functionality, Add a functionality to disab…
dhruvgoel92 Mar 1, 2022
422352a
Merge pull request #2137 from Aerotime/disableAutoScroll
pietrofxq Mar 2, 2022
89dd0fb
chore(release): set `package.json` to 0.39.0 [skip ci]
semantic-release-bot Mar 2, 2022
a532b37
chore: Convert stories to current Storybook format
cutterbl Jan 4, 2022
c381812
chore: Adding prop stories
cutterbl Jan 6, 2022
33ac25e
docs: Additional props stories
cutterbl Jan 8, 2022
578750a
docs: Add more props
cutterbl Jan 9, 2022
a8e5fc5
docs: Continuing additions
cutterbl Jan 10, 2022
4fc2316
docs: Cleanup work
cutterbl Jan 11, 2022
73086bc
docs: Continue with props
cutterbl Jan 12, 2022
e439a6e
docs: Continued props documentation
cutterbl Jan 13, 2022
91915ce
docs: Beginning Examples documentation
cutterbl Jan 16, 2022
1043388
docs: Continuing Examples
cutterbl Jan 17, 2022
f4a69db
docs: Begin Drag and Drop documentation
cutterbl Jan 18, 2022
de67e6f
docs: Continuing documentation
cutterbl Jan 19, 2022
0f7603e
docs: Beginning DnD props docs
cutterbl Jan 19, 2022
b03cb49
docs: Wrap up documentation
cutterbl Jan 20, 2022
1fdef3f
docs: Add a little more
cutterbl Jan 20, 2022
ecc02e0
docs: Polish
cutterbl Jan 20, 2022
f725f82
ci: Update to SB release
cutterbl Jan 20, 2022
bef078e
ci: Correct folder name
cutterbl Jan 20, 2022
a9ec44b
docs: Continued refinement
cutterbl Jan 21, 2022
7b943ef
chore: Remove old Examples
cutterbl Jan 21, 2022
a1650e7
docs: Add localizer switching to Duration stories
cutterbl Feb 3, 2022
6da7f5c
chore: Bring in updates from master
cutterbl Mar 9, 2022
aad88fe
chore: Continued merge
cutterbl Mar 9, 2022
3d25079
chore: Update lockfile
cutterbl Mar 9, 2022
04e6d46
docs: Localizers Guide
cutterbl Mar 9, 2022
afa8468
fix: Correct resizing event bug in Week & Day (#2143)
OldDream Mar 10, 2022
91eec18
chore(release): set `package.json` to 0.39.1 [skip ci]
semantic-release-bot Mar 10, 2022
3632345
fix: Correct resize for multi-day event. (#2138)
dhruvgoel92 Mar 10, 2022
35f33d5
chore(release): set `package.json` to 0.39.2 [skip ci]
semantic-release-bot Mar 10, 2022
42713df
chore: Expose slotMetrics to DayColumnWrapper component (#2132)
dhruvgoel92 Mar 11, 2022
cd385f5
fix: Trade href="#" anchors for stylized buttons (#2074)
cutterbl Mar 11, 2022
af82bd7
chore(release): set `package.json` to 0.39.3 [skip ci]
semantic-release-bot Mar 11, 2022
d16b295
ci: update scripting
cutterbl Mar 11, 2022
38467e6
ci: new issue workflows
cutterbl Mar 11, 2022
ad3ad17
ci: correct token refs
cutterbl Mar 11, 2022
d9cbb84
ci: remove unnecessary deps
cutterbl Mar 11, 2022
adddf8a
ci: update eslint
cutterbl Mar 11, 2022
b7d0149
ci: final updates
cutterbl Mar 11, 2022
741ef24
ci: remove comments
cutterbl Mar 11, 2022
2e2ca85
chore: Convert stories to current Storybook format
cutterbl Jan 4, 2022
b190266
chore: Adding prop stories
cutterbl Jan 6, 2022
2524133
docs: Additional props stories
cutterbl Jan 8, 2022
6030b2f
docs: Add more props
cutterbl Jan 9, 2022
48eb7b4
docs: Continuing additions
cutterbl Jan 10, 2022
59abf75
docs: Cleanup work
cutterbl Jan 11, 2022
164fd7c
docs: Continue with props
cutterbl Jan 12, 2022
9b368dc
docs: Continued props documentation
cutterbl Jan 13, 2022
46179df
docs: Beginning Examples documentation
cutterbl Jan 16, 2022
c5957a2
docs: Continuing Examples
cutterbl Jan 17, 2022
3aa8ebe
docs: Begin Drag and Drop documentation
cutterbl Jan 18, 2022
f73e73c
docs: Continuing documentation
cutterbl Jan 19, 2022
93a96cd
docs: Beginning DnD props docs
cutterbl Jan 19, 2022
0b89bec
docs: Wrap up documentation
cutterbl Jan 20, 2022
80d51b2
docs: Add a little more
cutterbl Jan 20, 2022
76bb508
docs: Polish
cutterbl Jan 20, 2022
ddb80f9
ci: Update to SB release
cutterbl Jan 20, 2022
d330c3e
ci: Correct folder name
cutterbl Jan 20, 2022
50940ff
docs: Continued refinement
cutterbl Jan 21, 2022
764f337
chore: Remove old Examples
cutterbl Jan 21, 2022
bcf4ad4
docs: Add localizer switching to Duration stories
cutterbl Feb 3, 2022
7e5701d
chore: Bring in updates from master
cutterbl Mar 9, 2022
247c7ec
chore: Convert stories to current Storybook format
cutterbl Jan 4, 2022
60894fc
chore: Adding prop stories
cutterbl Jan 6, 2022
7ddf377
docs: Additional props stories
cutterbl Jan 8, 2022
ae1f548
docs: Continue with props
cutterbl Jan 12, 2022
5f261df
docs: Continued props documentation
cutterbl Jan 13, 2022
84640e9
docs: Continuing Examples
cutterbl Jan 17, 2022
b7124a1
docs: Begin Drag and Drop documentation
cutterbl Jan 18, 2022
a964c79
docs: Continuing documentation
cutterbl Jan 19, 2022
23b0651
docs: Beginning DnD props docs
cutterbl Jan 19, 2022
a253121
docs: Wrap up documentation
cutterbl Jan 20, 2022
6a2746b
docs: Add a little more
cutterbl Jan 20, 2022
5e6f14c
docs: Polish
cutterbl Jan 20, 2022
47262fc
docs: Continued refinement
cutterbl Jan 21, 2022
28fe5af
chore: Remove old Examples
cutterbl Jan 21, 2022
91c6562
chore: Update lockfile
cutterbl Mar 9, 2022
d9ad163
docs: Localizers Guide
cutterbl Mar 9, 2022
df95e2f
ci: update scripting
cutterbl Mar 11, 2022
94395fa
ci: new issue workflows
cutterbl Mar 11, 2022
01c7f46
ci: correct token refs
cutterbl Mar 11, 2022
ca5cfad
ci: remove unnecessary deps
cutterbl Mar 11, 2022
2cc6f42
ci: update eslint
cutterbl Mar 11, 2022
84d3cdf
ci: final updates
cutterbl Mar 11, 2022
031b697
ci: remove comments
cutterbl Mar 11, 2022
35fe5c3
ci: after rebase
cutterbl Mar 11, 2022
271e292
chore: pull
cutterbl Mar 11, 2022
e424592
ci: better deps
cutterbl Mar 11, 2022
7406820
docs: updates
cutterbl Mar 13, 2022
5d5fb28
ci: latest lint-staged automatically does git add
cutterbl Mar 13, 2022
9d4fad3
ci: remove unnecessary dependencies
cutterbl Mar 13, 2022
98ffe1d
ci: remove unnecessary yml config
cutterbl Mar 13, 2022
1910381
ci: remove misnamed dupe file
cutterbl Mar 13, 2022
edb5bdd
ci: missing dep
cutterbl Mar 13, 2022
a0c0d59
ci: refine gh build workflow
cutterbl Mar 13, 2022
b1d656a
ci: refine gh build workflow
cutterbl Mar 13, 2022
71ebb39
ci: refine gh build workflow
cutterbl Mar 13, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
18 changes: 0 additions & 18 deletions .babelrc

This file was deleted.

3 changes: 3 additions & 0 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> 1%
not IE 11
last 2 versions
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules/
dist/
lib/
.*
21 changes: 0 additions & 21 deletions .eslintrc

This file was deleted.

34 changes: 34 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"parser": "@babel/eslint-parser",
"parserOptions": {
"ecmaVersion": 2020,
"sourceType": "module"
},
"extends": ["jason/react", "prettier"],
"plugins": ["react-hooks"],
"env": {
"node": true,
"browser": true,
"es6": true
},
"rules": {
"global-require": "off",
"no-console": [
"error",
{
"allow": ["warn", "error", "info"]
}
],
"no-unused-vars": [
"error",
{
"vars": "all",
"args": "after-used",
"varsIgnorePattern": "^_",
"argsIgnorePattern": "^_"
}
],
"react-hooks/rules-of-hooks": "error",
"react-hooks/exhaustive-deps": "warn"
}
}
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: "\U0001F680 New feature proposal"
description: Propose a new feature to be added to Big Calendar
labels: ['feature request']
body:
- type: markdown
attributes:
value: |
Thanks for your interest in the project and taking the time to fill out this feature request!
- type: textarea
id: feature-description
attributes:
label: Clear and concise description of the problem
description: As a developer using Big Calendar I want [goal / wish] so that [benefit]
validations:
required: true
- type: textarea
id: suggested-solution
attributes:
label: Suggested solution
description: 'In module [xy] we could provide following implementation...'
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Alternative
description: Clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context or screenshots about the feature request here.
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Read the [docs](http://jquense.github.io/react-big-calendar/examples/index.html).
required: true
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
required: true
- type: checkboxes
id: pr
attributes:
label: Would you like to open a PR for this feature?
description: Before starting to work on PR it is recommended to get maintainers approval. The fastest, and most appreciated way to have feature included is to create a pull request with working, tested code and we will help get it merged. Don't be scared to open a pull request that isn't completed and ask for input. We're happy to give direction!
options:
- label: I'm willing to open a PR
required: false
89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/new-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: 🐞 Big Calendar Issue
description: Create a report for Big Calendar
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
id: qa
attributes:
label: Check that this is really a bug
description: For Q&A open go to [StackOverflow](https://stackoverflow.com/)
options:
- label: I confirm
required: true
- type: input
id: reproduction
attributes:
label: Reproduction link
description: Please provide a link to a repo that can reproduce the problem you ran into. You can fork our [Issue Template](https://codesandbox.io/s/react-big-calendar-example-v9wdyd) in codesandbox to get start. A reproduction is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "missing demo" label. If no reproduction is provided after 3 days, it will be auto-closed.
placeholder: 'https://codesandbox.io/..'
validations:
required: true
- type: textarea
id: descr
attributes:
label: Bug description
description: A clear and concise description of what the bug is
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: A concise description of what you're experiencing
validations:
required: false
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: input
id: bigcalendar
attributes:
label: react-big-calendar version
description: Exact release version or commit hash
placeholder: e.g 0.39.3
validations:
required: true
- type: input
id: reactversion
attributes:
label: React version
description: Exact release version or commit hash
placeholder: e.g 17.0.2
validations:
required: true
- type: input
id: browser
attributes:
label: Platform/Target and Browser Versions
description: Platform client you are targeting such as macOS, Windows, Cordova, iOS, Android, Chrome, etc.
placeholder: e.g macOS Safari 14.1
validations:
required: true
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Read the [docs](http://jquense.github.io/react-big-calendar/examples).
required: true
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
required: true
- label: Make sure this is a react-big-calendar issue and not an implementation issue
required: true
- type: checkboxes
id: pr
attributes:
label: Would you like to open a PR for this bug?
description: Before starting to work on PR it is recommended to get maintainers approval. The fastest, and most appreciated way to have your issue fixed is to create a pull request with working, tested code and we will help get it merged. Don't be scared to open a pull request that isn't completed and ask for input. We're happy to give direction!
options:
- label: I'm willing to open a PR
required: false
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.

The best way to propose a feature is to open an issue first and discuss your ideas there before implementing them.

Always follow the [contribution guidelines](https://github.com/jquense/react-big-calendar/blob/master/CONTRIBUTING.md) when submitting a pull request.
17 changes: 17 additions & 0 deletions .github/workflows/issue-close-require.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Issue Close Require

on:
schedule:
- cron: '0 0 * * *'

jobs:
close-issues:
runs-on: ubuntu-latest
steps:
- name: missing demo
uses: actions-cool/[email protected]
with:
actions: 'close-issues'
token: ${{ secrets.GITHUB_TOKEN }}
labels: 'missing demo'
inactive-day: 3
19 changes: 19 additions & 0 deletions .github/workflows/issue-labeled.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Issue Labeled

on:
issues:
types: [labeled]

jobs:
reply-labeled:
runs-on: ubuntu-latest
steps:
- name: missing demo
if: github.event.label.name == 'missing demo'
uses: actions-cool/[email protected]
with:
actions: 'create-comment, remove-labels'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.issue.number }}
body: |
Hello @${{ github.event.issue.user.login }}. Please provide an online reproduction by [codesandbox](https://codesandbox.io/) or a minimal GitHub repository. You can fork our [Issue Template](https://codesandbox.io/s/react-big-calendar-example-v9wdyd) in codesandbox to get start. Issues labeled by `missing demo` will be closed if no activities in 3 days.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v2
Expand Down
32 changes: 32 additions & 0 deletions .github/workflows/storybook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Build and Deploy Documentation
on:
workflow_run:
workflows: ["Release"]
types: [completed]
branches:
- master
paths:
- 'src/**'
- 'stories/**'
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v3

- name: Install and Build 🔧
run: | # Install npm packages and build the Storybook files
npm ci
npm run build-storybook

- name: Deploy 🚀
# https://github.com/JamesIves/github-pages-deploy-action
uses: JamesIves/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages # The branch the action should deploy to.
folder: storybook-static # The folder that the build-storybook script generates files.
target-folder: examples
clean: true # Automatically remove deleted files from the deploy branch
commit-msg: 'docs: update documentation site'
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v2
Expand Down
2 changes: 1 addition & 1 deletion .husky/commit-msg
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx --no-install commitlint --edit "$1"
npx --no-install commitlint --edit ""
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged
7 changes: 7 additions & 0 deletions .lintstagedrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"src/**/*.js": "eslint",
"test/**/*.js": "eslint",
"*.{js,json,css,md}": [
"prettier --write"
]
}
5 changes: 5 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.*
stories
test
src
*.config.js
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"printWidth": 80,
"semi": false,
"singleQuote": true,
"trailingComma": "es5",
"bracketSpacing": true
}
Loading