Shadow DOM support for Capybara

The capybara-shadowm gem adds basic support for the Shadow DOM to Capybara.


Add this line to your application's Gemfile:

gem 'capybara-shadowdom'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install capybara-shadowdom


Given the custom element:

  <!-- #shadow-root start -->
  <span>Hello shadow world!</span>

  <input type="text" id="user_name">
  <!-- #shadow-root end -->

You will be able to do:

within custom_element.shadow_root do
  # Displays "Hello shadow world!":
  puts page.text

  # Asserts the text within the element:
  assert_text "Hello shadow world!"

  # Input elements within the shadow DOM will also be accessible:
  fill_in "#user_name", with: ""

Browser Support

  • Supported Selenium versions: 3.0 and above
  • Supported Ruby versions: 2.7 and above

Supported drivers:

Driver Browser Support Description
Selenium IE11 N/A Shadow DOM is not supported.
Selenium Edge
Selenium Firefox Fails with Cyclic object value.
Selenium Chrome
Selenium Safari
cuprite Embedded Chromium
apparition Embedded Chromium shadowRoot node can not be retrieved.


After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to


Bug reports and pull requests are welcome on GitHub at This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.


The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Capybara::Shadowdom project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.