Add deprecated css to clickable property name #2526

keremnalbant · 2024-04-24T17:34:18Z

What/Why/How?

What: ClickablePropertyName styled component doesn't pass the deprecated css to its child <span class='property-name'> and because of that property name doesn't get line-through style.

Solved it by adding the missing css code.

Reference

Tests

No tests needed

Screenshots (optional)

Before:

After:

Check yourself

Code is linted
Tested
All new/updated code is covered with tests

AlexVarchuk

Hi @keremnalbant, thank you for the contribution. I am not 100% sure about adding deprecated CSS to non-primitive property. The reason is nested properties. In that case, should we use the same style for them? It can confuse if count of properties is a lot.

keremnalbant · 2024-04-25T10:46:51Z

Hi @keremnalbant, thank you for the contribution. I am not 100% sure about adding deprecated CSS to non-primitive property. The reason is nested properties. In that case, should we use the same style for them? It can confuse if count of properties is a lot.

Hey @AlexVarchuk thanks for consideration. To me as a user it looked like a bug since it doesn't look consistent with the other deprecated properties.

If we approach the problem with a UI POV, it's not a really good practice to have different stylings for deprecated properties depending on their type.

For nested properties, thanks for raising it up. IMO, I don't think we should apply the same for them, deprecated flag and regarding styling only should be applied at root level.

In the API spec I tested against, It didn't have nested properties, let me see check that case and push another commit for that if needed.

AlexVarchuk · 2024-04-25T11:00:58Z

@lornajane any thoughts?

AlexVarchuk · 2024-04-25T11:04:28Z

@keremnalbant Also check tests. Seems, we need to update snapshots.

keremnalbant · 2024-04-25T11:55:05Z

@AlexVarchuk
Current implementation doesn't cover the nested properties, and I think that this way it's better because deprecated stylings should be applied at root level.

Also since this is my first contribution I couldn't get what you mean by checking the tests.
I already run npm run test, npm run test:update-snapshot scripts in my local before committing.

lornajane · 2024-04-25T13:17:01Z

I think it makes sense to apply the visual label where the deprecated property is applied, regardless of type.

* sync: Synced local 'docs/' with remote 'docs/redoc/' * chore: remove broken link from demo (Redocly#2338) * fix: renames 'FieldContstraints' to 'FieldConstraints' (Redocly#2352) Co-authored-by: Ricagraca <ricardo.graca@freiheit.com> * fix: schema oneOf title with const (Redocly#2350) * docs: adds vale rules and workflow for running in CI (Redocly#2348) * docs: adds vale rules and workflow for running in CI * docs: updates product name from ReDoc to Redoc * chore: update packages dependecy (Redocly#2360) * chore: update packages dependecy * fix: remove redundant options * fix: webpack config demo folder * fix: replace cypress ts-loader * chore: remove redundant dependency * chore(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 (Redocly#2359) Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4. - [Release notes](https://github.com/jonschlinkert/word-wrap/releases) - [Commits](jonschlinkert/word-wrap@1.2.3...1.2.4) --- updated-dependencies: - dependency-name: word-wrap dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: enable keyboard navigation (Redocly#2361) * docs: fix and update links in redoc-vendor-extensions (Redocly#2368) Co-authored-by: Lorna Jane Mitchell <github@lornajane.net> * feat: add x-tags (Redocly#2355) * feat: add x-tags * chore: fix e2e tests and add new for x-tag * chore: add x-tags to demo definition * chore: update snapshots * feat: add support of react 18 (Redocly#2369) * feat: add support of react 18 * chore: add newest version of styled-components to peerDependencies * chore: add supoort of styled components * chore: downgrade types * chore: update snapshots * chore: update cypress to 12.17.1 * chore: upgrade openapi-core to 1.0.0-rc.2 * chore: upgrade packages for fixing vulnerabilities * docs: Remove Redoc CLI and a non-existent config option * chore: v2.1.0 (Redocly#2382) * fix: hotfix, crash after 2.1 release * chore: v2.1.1 * chore: add tests for cover field default crash (Redocly#2389) * fix: react18 cli integration (Redocly#2404) * fix: react18 cli integration * fix: update unit tests snapshots * chore(deps): bump @cypress/request and cypress (Redocly#2410) Bumps [@cypress/request](https://github.com/cypress-io/request) to 3.0.1 and updates ancestor dependency [cypress](https://github.com/cypress-io/cypress). These dependencies need to be updated together. Updates `@cypress/request` from 2.88.11 to 3.0.1 - [Release notes](https://github.com/cypress-io/request/releases) - [Changelog](https://github.com/cypress-io/request/blob/master/CHANGELOG.md) - [Commits](cypress-io/request@v2.88.11...v3.0.1) Updates `cypress` from 12.17.1 to 13.1.0 - [Release notes](https://github.com/cypress-io/cypress/releases) - [Changelog](https://github.com/cypress-io/cypress/blob/develop/CHANGELOG.md) - [Commits](cypress-io/cypress@v12.17.1...v13.1.0) --- updated-dependencies: - dependency-name: "@cypress/request" dependency-type: indirect - dependency-name: cypress dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: style RefreshToken URL as <code> in the authorization section Co-authored-by: szaszeke <Szabolcs.Szekely@t-systems.com> * chore: v2.1.2 (Redocly#2413) * fix: more cases for react18 and cli integration (Redocly#2416) * Config docs and README refresh (Redocly#2393) * docs: Give Redoc a landing page with overview and tldr instructions * docs: move config to dedicated page * docs: modernise README, link to resources * docs: more detailed format for theme configurations * fix: README formatting * fix: Fix future tense errors and add exceptions for config fields as headings * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> * docs: minor updates from excellent pull request feedback * docs: Remove the old quickstart, update HTML as the preferred onboarding method and improve docs/examples on that page * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> --------- Co-authored-by: Heather Cloward <heathercloward@gmail.com> * sync: Synced local 'docs/' with remote 'docs/redoc/' * sync: Synced local 'docs/' with remote 'docs/redoc/' * sync: Synced local 'docs/' with remote 'docs/redoc/' * sync: Synced local 'docs/' with remote 'docs/redoc/' * sync: Synced local 'docs/' with remote 'docs/redoc/' * chore(deps-dev): bump postcss from 8.4.27 to 8.4.31 (Redocly#2427) Bumps [postcss](https://github.com/postcss/postcss) from 8.4.27 to 8.4.31. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](postcss/postcss@8.4.27...8.4.31) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * sync: Synced local 'docs/' with remote 'docs/redoc/' * fix: default value as object in request body (Redocly#2437) * fix: hideRequestPayloadSample (Redocly#2436) * fix: display string pattern in array items (Redocly#2438) * chore: v2.1.3 (Redocly#2439) * sync: Synced local 'docs/' with remote 'docs/redoc/' * docs: fix admonition on config page (Redocly#2452) * Update README.md (Redocly#2422) Fix link to deployment options * docs: Remove references to interactive docs in the open source project (Redocly#2460) * docs: Remove references to interactive docs in the open source project * Update README.md Co-authored-by: Adam Altman <adam@redoc.ly> --------- Co-authored-by: Adam Altman <adam@redoc.ly> * Add Quaderno API to README's Showcase section (Redocly#2468) * chore: Update directory structure for Vale v3 (Redocly#2477) * chore: Update directory structure for Vale v3 * chore: update Vale folder name * docs: Add docs tooling to align with publishing to main site (Redocly#2484) * docs: add markdownlint and some link checks alongside vale * docs: add link checker config and fix/update some links reported broken * docs: update markdownlint action * docs: fix markdown table formatting * docs: Unpin Vale version and pick up the latest * docs: Fix a link that couldn't be checked as it reaches outside the Redoc project (Redocly#2490) * docs: Update API examples list to include Museum API (Redocly#2506) * feat: Update API examples list to include Museum API * updates museum.yaml with logo and replaces petstore with museum api in playground for local dev and some minor edits to redoc name * docs: update definition --------- Co-authored-by: Heather Cloward <heathercloward@gmail.com> Co-authored-by: Alex Varchuk <olexandr.varchuk@gmail.com> * chore: fix vulnerabilities and upgrade deps (Redocly#2445) * chore: fix vulnerabilities and upgrade deps * chore: use old version of cypress * fix: additional vulnerabilities * chore: add check-version to publish script (Redocly#2446) * fix: publish script (Redocly#2524) * chore: upgrade openapi-sampler (Redocly#2525) * chore: upgrade cypress to fix e2e tests and update-browserslist-db (Redocly#2529) * fix: use h2/h3 for headings instead of h1/h2 for better seo (Redocly#2514) * fix: use h2/h3 for headings instead of h1/h2 for better seo * fix: fixed e2e tests for changed headings --------- Co-authored-by: Max Krumpe <max.krumpe@uniserv.com> * fix: add deprecated css to clickable property name (Redocly#2526) Co-authored-by: Kerem Nalbant <k.nalbant@epilot.cloud> * chore: v2.1.4 (Redocly#2530) * chore: fix docker publish action (Redocly#2531) * docs: Remove outdated sync job for docs folder (Redocly#2465) * chore: move jest-environment-jsdom to dev dependencies (Redocly#2543) * fix: update react to 18 and react-tabs to 6 (Redocly#2547) * chore: v2.1.5 (Redocly#2550) * chore: upgrade vulnerable dev dependencies * chore: remove heavy bundlesize dev dependency * docs: update broken link of Openapi Object (Redocly#2577) * fix: show siblings schema with oneOf (Redocly#2576) * docs: fix http-server example from in-page feedback (Redocly#2580) * chore: upgrade node version for docker (Redocly#2589) * docs: Remove the old zero-dependency claim for Redoc docs (Redocly#2590) * chore: Remove the sync job, we don't use it any more (Redocly#2591) * chore(deps): bump body-parser and express (Redocly#2603) Bumps [body-parser](https://github.com/expressjs/body-parser) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together. Updates `body-parser` from 1.20.2 to 1.20.3 - [Release notes](https://github.com/expressjs/body-parser/releases) - [Changelog](https://github.com/expressjs/body-parser/blob/master/HISTORY.md) - [Commits](expressjs/body-parser@1.20.2...1.20.3) Updates `express` from 4.19.2 to 4.21.1 - [Release notes](https://github.com/expressjs/express/releases) - [Changelog](https://github.com/expressjs/express/blob/4.21.1/History.md) - [Commits](expressjs/express@4.19.2...4.21.1) --- updated-dependencies: - dependency-name: body-parser dependency-type: indirect - dependency-name: express dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump dompurify from 3.0.6 to 3.1.3 (Redocly#2602) Bumps [dompurify](https://github.com/cure53/DOMPurify) from 3.0.6 to 3.1.3. - [Release notes](https://github.com/cure53/DOMPurify/releases) - [Commits](cure53/DOMPurify@3.0.6...3.1.3) --- updated-dependencies: - dependency-name: dompurify dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: add support x-badges (Redocly#2605) * feat: add support x-badges Co-authored-by: Max Mueller <maxmueller@eaton.com> * chore: try to fix e2e tests * chore: try to fix e2e tests part 2 * Update docs/redoc-vendor-extensions.md --------- Co-authored-by: Max Mueller <maxmueller@eaton.com> Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com> * chore: v2.2.0 (Redocly#2606) * fix: docker build (Redocly#2607) * docs(all): change admonition type to 'info' (Redocly#2608) * chore: updated webpack version to 5.94.0 (Redocly#2583) * feat: update pattern styling (Redocly#2196) (Redocly#2600) Closes Redocly#2196 * chore: npm audit for previnting feature vulnerabilities (Redocly#2612) * formatting * readme formatting * operations * types * utils * badges in spec * update package lock * snapshots * wf updates * spec * snapshot * search tests * fix e2e tests * update styled-components * dont update --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: redocly-bot <null> Co-authored-by: Alex Varchuk <olexandr.varchuk@gmail.com> Co-authored-by: Ricardo Graça <33238205+Ricagraca@users.noreply.github.com> Co-authored-by: Ricagraca <ricardo.graca@freiheit.com> Co-authored-by: Heather Cloward <heathercloward@gmail.com> Co-authored-by: Oprysk Viacheslav <vyacheslav@redocly.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Roman Pidkostelnyi <63608794+RomanPidkostelnyi@users.noreply.github.com> Co-authored-by: Adam Altman <adam@redoc.ly> Co-authored-by: Lorna Jane Mitchell <github@lornajane.net> Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com> Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com> Co-authored-by: ckszabi <ckszabi@gmail.com> Co-authored-by: szaszeke <Szabolcs.Szekely@t-systems.com> Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com> Co-authored-by: Alexei Maridashvili <alexei.maridashvili@gmail.com> Co-authored-by: Javi Rubio <javier.rubio.rubio@gmail.com> Co-authored-by: Max Krumpe <42165374+maxkrumpe@users.noreply.github.com> Co-authored-by: Max Krumpe <max.krumpe@uniserv.com> Co-authored-by: Kerem Nalbant <43813768+keremnalbant@users.noreply.github.com> Co-authored-by: Kerem Nalbant <k.nalbant@epilot.cloud> Co-authored-by: Max Mueller <maxmueller@eaton.com> Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com> Co-authored-by: Taylor Krusen <taylor.krusen@redocly.com> Co-authored-by: Dxuian <92696836+Dxuian@users.noreply.github.com> Co-authored-by: Michael Huynh <43751307+miqh@users.noreply.github.com>

Add deprecated css to clickable property name

5dc43fa

keremnalbant requested a review from a team as a code owner April 24, 2024 17:34

AlexVarchuk requested changes Apr 25, 2024

View reviewed changes

AlexVarchuk approved these changes Apr 25, 2024

View reviewed changes

AlexVarchuk merged commit b0d03d0 into Redocly:main Apr 25, 2024
3 checks passed

AlexVarchuk mentioned this pull request Apr 25, 2024

chore: v2.1.4 #2530

Merged

3 tasks

This was referenced Aug 7, 2024

[Snyk] Upgrade redoc from 2.0.0-rc.53 to 2.1.5 mkajitansnyk/gravitee-gateway#2867

Open

[Snyk] Upgrade redoc from 2.0.0-rc.53 to 2.1.5 mkajitansnyk/gravitee-gateway#2872

Open

This was referenced Sep 6, 2024

[Snyk] Upgrade redoc from 2.0.0-rc.53 to 2.1.5 mkajitansnyk/gravitee-gateway#2918

Open

[Snyk] Upgrade redoc from 2.0.0-rc.53 to 2.1.5 mkajitansnyk/gravitee-gateway#2928

Open

[Snyk] Upgrade redoc from 2.0.0-rc.53 to 2.1.5 mkajitansnyk/gravitee-gateway#2941

Open

mkajitansnyk mentioned this pull request Oct 24, 2024

[Snyk] Upgrade redoc from 2.0.0-rc.53 to 2.1.5 mkajitansnyk/gravitee-gateway#3049

Open

mkajitansnyk mentioned this pull request Nov 12, 2024

[Snyk] Upgrade redoc from 2.0.0-rc.53 to 2.2.0 mkajitansnyk/gravitee-gateway#3074

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add deprecated css to clickable property name #2526

Add deprecated css to clickable property name #2526

keremnalbant commented Apr 24, 2024 •

edited

Loading

AlexVarchuk left a comment

keremnalbant commented Apr 25, 2024 •

edited

Loading

AlexVarchuk commented Apr 25, 2024

AlexVarchuk commented Apr 25, 2024

keremnalbant commented Apr 25, 2024

lornajane commented Apr 25, 2024

Add deprecated css to clickable property name #2526

Add deprecated css to clickable property name #2526

Conversation

keremnalbant commented Apr 24, 2024 • edited Loading

What/Why/How?

Reference

Tests

Screenshots (optional)

Check yourself

AlexVarchuk left a comment

Choose a reason for hiding this comment

keremnalbant commented Apr 25, 2024 • edited Loading

AlexVarchuk commented Apr 25, 2024

AlexVarchuk commented Apr 25, 2024

keremnalbant commented Apr 25, 2024

lornajane commented Apr 25, 2024

keremnalbant commented Apr 24, 2024 •

edited

Loading

keremnalbant commented Apr 25, 2024 •

edited

Loading