added comments. updated Changelog

namespace-ee · Jan 21, 2018 · f916312 · f916312
1 parent 4c5792b
commit f916312
Show file tree

Hide file tree

Showing 2 changed files with 97 additions and 54 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,134 +1,175 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres (more or less) to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
+
 When you submit a PR, add your changes here!
 
+### Added
+
+* `timelineContext` is provided to `itemRenderer` #233
+
 ## 0.15.6
 
 ### Fixed
-- Fixed issue with state not properly updated when ending resize #173
-- Fixed issue with onItem* events not reporting correct time when timeline has outer padding #227
+
+* Fixed issue with state not properly updated when ending resize #173
+* Fixed issue with onItem\* events not reporting correct time when timeline has outer padding #227
 
 ## 0.15.5
 
 ### Fixed
-- context click actually calls double click callback #225
-- Removed href attribute from header divs #222
+
+* context click actually calls double click callback #225
+* Removed href attribute from header divs #222
 
 ## 0.15.4
 
 ### Fixed
-- Clicking on Svg element throws error #216
+
+* Clicking on Svg element throws error #216
 
 ## 0.15.3
-This version contains one crucial bug fix and a simple update to item clicks to report time.  Much of the other work was around repo maintenance and preparing the repo for future development (update to dev-tooling, some documentation updates)
+
+This version contains one crucial bug fix and a simple update to item clicks to report time. Much of the other work was around repo maintenance and preparing the repo for future development (update to dev-tooling, some documentation updates)
 
 ### Added
-- Report time with all item clicks #210
+
+* Report time with all item clicks #210
 
 ### Fixed
-- Drag doesn't stop when you leave the timeline canvas #182
+
+* Drag doesn't stop when you leave the timeline canvas #182
 
 ## [0.15.0]
+
 Plugin support and sticky header!
 
 ### Added
-- Plugins system (pass them as children) @mariusandra #122
-- Sticky header (`fixedHeader='sticky'`) @mariusandra #125
+
+* Plugins system (pass them as children) @mariusandra #122
+* Sticky header (`fixedHeader='sticky'`) @mariusandra #125
 
 ### Removed
-- [BREAKING] Removed deprecated option to pass sidebar header content as children. Use `sidebarContent` instead. @mariusandra
-- [BREAKING] Removed fixedHeader option `absolute`, which was broken and is now replaced with the option `sticky` @mariusandra
+
+* [BREAKING] Removed deprecated option to pass sidebar header content as children. Use `sidebarContent` instead. @mariusandra
+* [BREAKING] Removed fixedHeader option `absolute`, which was broken and is now replaced with the option `sticky` @mariusandra
 
 ### Demo & Docs
-- Notice for modern module bundlers @jlubben @mariusandra #128
-- Add [treeGroups](http://namespace.ee/react-calendar-timeline-docs/#/treeGroups) demo
+
+* Notice for modern module bundlers @jlubben @mariusandra #128
+* Add [treeGroups](http://namespace.ee/react-calendar-timeline-docs/#/treeGroups) demo
 
 ## [0.14.11]
+
 Plenty of bugfixes, tests and new demos in these 0.14 patch releases.
 
 ### Fixed
-- Fixed bug with `resizeDetector` and with detecting changes in `sidebarWidth` @mariusandra
-- Fixed bug where order `0` was evaluated as a falsy @nicocrm #111
-- Fix overflow-x with header @signalwerk
+
+* Fixed bug with `resizeDetector` and with detecting changes in `sidebarWidth` @mariusandra
+* Fixed bug where order `0` was evaluated as a falsy @nicocrm #111
+* Fix overflow-x with header @signalwerk
 
 ### Added
-- Add meta+wheel modifier that zooms 3x the speed of the normal wheel events @mariusandra
+
+* Add meta+wheel modifier that zooms 3x the speed of the normal wheel events @mariusandra
 
 ### Changed
-- Refactor `calculateDimensions` to be pure @signalwerk
-- Convert `groupHeights` and `groupTops` to arrays (from objects) @mariusandra
+
+* Refactor `calculateDimensions` to be pure @signalwerk
+* Convert `groupHeights` and `groupTops` to arrays (from objects) @mariusandra
 
 ### Demo & docs
-- Add [linkedTimelines](http://namespace.ee/react-calendar-timeline-docs/#/linkedTimelines) demo
-- Add [elementResize](http://namespace.ee/react-calendar-timeline-docs/#/elementResize) demo
-- Add docs about modifier keys for zooming/scrolling @signalwerk
+
+* Add [linkedTimelines](http://namespace.ee/react-calendar-timeline-docs/#/linkedTimelines) demo
+* Add [elementResize](http://namespace.ee/react-calendar-timeline-docs/#/elementResize) demo
+* Add docs about modifier keys for zooming/scrolling @signalwerk
 
 ## [0.14.2]
+
 ### Changed
-- Use `prop-types` instead of `React.PropTypes` to support React 15.5+. @mariusandra #110
+
+* Use `prop-types` instead of `React.PropTypes` to support React 15.5+. @mariusandra #110
 
 ## [0.14.0]
+
 ### Added
-- Use `headerLabelFormats` and `subHeaderLabelFormats` to customise the header labels. @Slowyn #68
-- Optional pluggable `resizeDetector` to detect when the element's container is resized. @Ziller321 #94
+
+* Use `headerLabelFormats` and `subHeaderLabelFormats` to customise the header labels. @Slowyn #68
+* Optional pluggable `resizeDetector` to detect when the element's container is resized. @Ziller321 #94
 
 ### Fixed
-- Fix renders with empty `groups` array. @signalwerk #106
+
+* Fix renders with empty `groups` array. @signalwerk #106
 
 ## [0.13.0]
+
 ### Added
-- An option to add another sidebar to the right of the Timeline. @goooseman #80
-- `itemRenderer` prop to allow specifying a custom component to render the items @nicocrm #103
-- `groupRenderer` prop to allow specifying a custom component to render the groups @nicocrm #103
-- `showCursorLine` prop to show a vertical line at the snap position @meikoudras
-- You can now select multiple items if you take control of the `selected` prop and the `onItemSelect` handler. @meengit #71
-- Canvas context menu handler `onCanvasContextMenu` @meikoudras
+
+* An option to add another sidebar to the right of the Timeline. @goooseman #80
+* `itemRenderer` prop to allow specifying a custom component to render the items @nicocrm #103
+* `groupRenderer` prop to allow specifying a custom component to render the groups @nicocrm #103
+* `showCursorLine` prop to show a vertical line at the snap position @meikoudras
+* You can now select multiple items if you take control of the `selected` prop and the `onItemSelect` handler. @meengit #71
+* Canvas context menu handler `onCanvasContextMenu` @meikoudras
 
 ### Fixed
-- Calculate width when we receive sidebar width property @jmerriweather #75
-- Avoid updating updateDimensions right after updateScrollCanvas @nicocrm #87
-- Fix typo collision detection in stack() @nicocrm #96
-- Remove dead code @signalwerk #101
-- Disable cursor style by interactjs @bkniffler #89
-- Fixed header width and Header label weekday support @meikoudras #66
+
+* Calculate width when we receive sidebar width property @jmerriweather #75
+* Avoid updating updateDimensions right after updateScrollCanvas @nicocrm #87
+* Fix typo collision detection in stack() @nicocrm #96
+* Remove dead code @signalwerk #101
+* Disable cursor style by interactjs @bkniffler #89
+* Fixed header width and Header label weekday support @meikoudras #66
 
 ### Changed
-- [Deprecated] To have content above the left sidebar, pass it in a `sidebarContent={<div />}` prop, not as children to the component.
+
+* [Deprecated] To have content above the left sidebar, pass it in a `sidebarContent={<div />}` prop, not as children to the component.
 
 ## [0.11.1]
+
 ### Fixed
-- Without canResize prop in items it gave a Uncaught TypeError. @tgosp
+
+* Without canResize prop in items it gave a Uncaught TypeError. @tgosp
 
 ## [0.11.0]
+
 ### Added
-- An option to fully update the calendar at every scroll event. With this change, labels of items are always fully visible, even if looking at a multi day event with a zoom level set at 30min. @mariusandra
+
+* An option to fully update the calendar at every scroll event. With this change, labels of items are always fully visible, even if looking at a multi day event with a zoom level set at 30min. @mariusandra
 
 ## [0.10.1]
+
 ### Changed
-- The left resize edge mouse cursor is now a left arrow @mariusandra
+
+* The left resize edge mouse cursor is now a left arrow @mariusandra
 
 ## [0.10.0]
+
 ### Added
-- You can also resize items from the left now @mariusandra
+
+* You can also resize items from the left now @mariusandra
 
 ## [0.9.0]
+
 ### Added
-- Allow disabling selection clicks on items #58 by @sjchmiela
-- Allow passing additional props to `Item`'s `<div/>` #58 by @sjchmiela
-- Add `clickTolerance` so dragging more than 3 pixels is no longer a click @mariusandra
+
+* Allow disabling selection clicks on items #58 by @sjchmiela
+* Allow passing additional props to `Item`'s `<div/>` #58 by @sjchmiela
+* Add `clickTolerance` so dragging more than 3 pixels is no longer a click @mariusandra
 
 ### Changed
-- [BREAKING] Same arguments order (groupId, time, e) for onCanvasDoubleClick and onCanvasClick #52 by @signalwerk
-- [Deprecated] `onTimeChange` now gets `updateScrollCanvas` as the third argument. Doing `this.updateScrollCanvas` is no longer needed and will be removed soon.
-- Moved React & Moment from dependencies to peerDependencies #53 by @meikoudras
-- Fix resizing when inside DIV #47 by @semargal
-- Fix demo for IE11 #44 by @lucidlemon
-- Package a .css file, not a .scss file as previously done. @mariusandra
+
+* [BREAKING] Same arguments order (groupId, time, e) for onCanvasDoubleClick and onCanvasClick #52 by @signalwerk
+* [Deprecated] `onTimeChange` now gets `updateScrollCanvas` as the third argument. Doing `this.updateScrollCanvas` is no longer needed and will be removed soon.
+* Moved React & Moment from dependencies to peerDependencies #53 by @meikoudras
+* Fix resizing when inside DIV #47 by @semargal
+* Fix demo for IE11 #44 by @lucidlemon
+* Package a .css file, not a .scss file as previously done. @mariusandra
 
 [0.9.0]: https://github.com/namespace-ee/react-calendar-timeline/compare/v0.8.6...v0.9.0
 [0.10.0]: https://github.com/namespace-ee/react-calendar-timeline/compare/v0.9.0...v0.10.0

diff --git a/src/lib/Timeline.js b/src/lib/Timeline.js
@@ -295,7 +295,9 @@ export default class ReactCalendarTimeline extends Component {
       getTimelineContext: () => {
         const { width, visibleTimeStart, visibleTimeEnd } = this.state
 
-        //prob wanna memoize this so we ensure that if no items changed, we return same reference
+        //TODO: Performance
+        //prob wanna memoize this so we ensure that if no items changed,
+        //we return same context reference
         return {
           timelineWidth: width,
           visibleTimeStart,