Skip to content

Commit 078c033

Browse files
authored
New release: 4.3.0 (#62)
* fix: when the container component has only one content component * fix: modify unit tests * chore: change version * chore: some changes to PR request file * fix: publish github action * Create new release (#61) * breacking change(rename): components * chore: update tests * change: today text to active * add(events): optional subtitle prop * fix(test): optional subtitle prop * add(event): description symbol * improve(a11y): change div and p elements to ul and li * chore(tests): improve test and coverage * add(events-event): allow render closed some event componentes inside events componente * chore: order alphabetically asc all imports and attributes * chore(package): change version * fix(tests): improve coverage * add(template): config template * add(template): features requests * add(pull-request-template): add issue section * chore(documentation): change content * fix(test): update snapshots * chore(template): some changes in pull_request_template file
1 parent e48d0ee commit 078c033

File tree

65 files changed

+633
-474
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+633
-474
lines changed

.eslintrc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@ module.exports = {
2020
'@typescript-eslint/no-explicit-any': 0,
2121
'no-underscore-dangle': 0,
2222
'@typescript-eslint/naming-convention': 0,
23+
'jest/expect-expect': 0,
2324
},
2425
};

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Ask the community
3+
url: https://github.com/Proskynete/vertical-timeline-component-react/discussions/new
4+
about: Ask and discuss questions with other members of the community.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Feature request
2+
description: Suggest new or updated features to include the library.
3+
title: 'Suggest a new feature'
4+
labels: [feature]
5+
assignees: []
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Prerequisites
10+
description: Please take a couple of minutes to help me work faster.
11+
options:
12+
- label: I have [searched](https://github.com/Proskynete/vertical-timeline-component-react/issues?q=is%3Aissue) for duplicate or closed feature requests
13+
required: true
14+
- label: I have read the [contributing guidelines](https://github.com/Proskynete/vertical-timeline-component-react/blob/master/CONTRIBUTING.md)
15+
required: true
16+
- type: textarea
17+
id: proposal
18+
attributes:
19+
label: Proposal
20+
description: Please provide detailed information on what we should add.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: motivation
25+
attributes:
26+
label: Motivation and context
27+
description: Tell us why this change is needed or helpful, and what problems it may help solve.
28+
validations:
29+
required: true

.github/pull_request_template.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
44

5-
Fixes # (issue)
5+
## 🎯 Issues
6+
7+
Write here the list of issues that the PR is solving
68

79
## 👾 Type of change
810

@@ -18,9 +20,6 @@ Please delete options that are not relevant.
1820

1921
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
2022

21-
- [ ] Test A
22-
- [ ] Test B
23-
2423
## ✅ Checklist
2524

2625
- [ ] My code follows the style guidelines of this project

README.md

Lines changed: 71 additions & 71 deletions
Large diffs are not rendered by default.

lib/cjs/components/container/index.d.ts

Lines changed: 0 additions & 4 deletions
This file was deleted.

lib/cjs/components/content/index.d.ts

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
interface ErrorMessageProps {
2-
type: 'atLeast' | 'onlySupports';
32
component: string;
3+
type: 'atLeast' | 'onlySupports';
44
}
55
declare const ErrorMessage: ({ type, component }: ErrorMessageProps) => JSX.Element;
66
export { ErrorMessage };
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { ContentProps } from '../../interfaces';
2+
declare const Event: ({ collapse, defaultClosed, description, title }: ContentProps) => JSX.Element;
3+
export { Event };

lib/cjs/components/content/index.js renamed to lib/cjs/components/event/index.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
2323
return result;
2424
};
2525
Object.defineProperty(exports, "__esModule", { value: true });
26-
exports.Content = void 0;
26+
exports.Event = void 0;
2727
var react_1 = __importStar(require("react"));
2828
var useConfig_1 = require("../../hooks/useConfig");
2929
var main_1 = require("../../styles/main");
30-
var Content = function (_a) {
30+
var Event = function (_a) {
3131
var _b;
32-
var title = _a.title, description = _a.description, collapse = _a.collapse;
32+
var collapse = _a.collapse, defaultClosed = _a.defaultClosed, description = _a.description, title = _a.title;
3333
var config = (0, useConfig_1.useConfig)().config;
34-
var _c = (0, react_1.useState)(true), show = _c[0], setShow = _c[1];
34+
var _c = (0, react_1.useState)(!defaultClosed), show = _c[0], setShow = _c[1];
3535
var isCollapsed = collapse || config.collapse;
3636
var handleSetShow = function () {
3737
setShow(!show);
@@ -45,7 +45,7 @@ var Content = function (_a) {
4545
title),
4646
show && (react_1.default.createElement(main_1.DescriptionWrapper, null, description.map(function (text, i) {
4747
var _a;
48-
return (react_1.default.createElement(main_1.Description, { key: i, style: (_a = config.customStyles) === null || _a === void 0 ? void 0 : _a.description }, text));
48+
return (react_1.default.createElement(main_1.Description, { key: i, symbol: config.descriptionSymbol, style: (_a = config.customStyles) === null || _a === void 0 ? void 0 : _a.description }, text));
4949
})))));
5050
};
51-
exports.Content = Content;
51+
exports.Event = Event;

0 commit comments

Comments
 (0)